diff --git a/client/swagger.yaml b/client/swagger.yaml
index e69de29..a9bf5d3 100644
--- a/client/swagger.yaml
+++ b/client/swagger.yaml
@@ -0,0 +1,206454 @@
+openapi: 3.0.3
+info:
+ title: API Documentation
+ version: 1.5.7 (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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ parameters:
+ - in: query
+ name: cable
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Cable
+ explode: true
+ style: form
+ - in: query
+ name: cable__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Cable
+ explode: true
+ style: form
+ - 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)
+ - 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: location
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Location (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: location__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Location (slug or 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: 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: region
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Region (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: region__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Region (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: region_id
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Region (ID) (deprecated, use "region" filter instead)
+ explode: true
+ style: form
+ - in: query
+ name: region_id__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Region (ID) (deprecated, use "region" filter instead)
+ explode: true
+ style: form
+ - in: query
+ name: site
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Site (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: site__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Site (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: site_id
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ nullable: true
+ description: Site (ID) (deprecated, use "site" filter instead)
+ explode: true
+ style: form
+ - in: query
+ name: site_id__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ nullable: true
+ description: Site (ID) (deprecated, use "site" filter instead)
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - circuits
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableCircuitTerminationRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - circuits
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableCircuitTerminationRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/CircuitTermination'
+ description: ''
+ patch:
+ operationId: circuits_circuit_terminations_bulk_partial_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - circuits
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableCircuitTerminationRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/CircuitTermination'
+ description: ''
+ delete:
+ operationId: circuits_circuit_terminations_bulk_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - circuits
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /circuits/circuit-terminations/{id}/:
+ get:
+ operationId: circuits_circuit_terminations_retrieve
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/WritableCircuitTerminationRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/PatchedWritableCircuitTerminationRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/CircuitTermination'
+ description: ''
+ delete:
+ operationId: circuits_circuit_terminations_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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}/notes/:
+ get:
+ operationId: circuits_circuit_terminations_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this circuit termination.
+ 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:
+ - circuits
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: circuits_circuit_terminations_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - circuits
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CircuitTypeRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - circuits
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableCircuitTypeRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/CircuitType'
+ description: ''
+ patch:
+ operationId: circuits_circuit_types_bulk_partial_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - circuits
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableCircuitTypeRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/CircuitType'
+ description: ''
+ delete:
+ operationId: circuits_circuit_types_bulk_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - circuits
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /circuits/circuit-types/{id}/:
+ get:
+ operationId: circuits_circuit_types_retrieve
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/CircuitTypeRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/PatchedCircuitTypeRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/CircuitType'
+ description: ''
+ delete:
+ operationId: circuits_circuit_types_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/circuit-types/{id}/notes/:
+ get:
+ operationId: circuits_circuit_types_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this circuit type.
+ 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:
+ - circuits
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: circuits_circuit_types_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /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
+ - in: query
+ name: location
+ schema:
+ type: array
+ items:
+ type: string
+ description: Location (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: location__n
+ schema:
+ type: array
+ items:
+ type: string
+ description: Location (slug or 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: 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
+ format: uuid
+ description: Tenant (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: tenant__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Tenant (slug or ID)
+ 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) (deprecated, use "tenant" filter instead)
+ explode: true
+ style: form
+ - in: query
+ name: tenant_id__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ nullable: true
+ description: Tenant (ID) (deprecated, use "tenant" filter instead)
+ 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/WritableCircuitRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableCircuitRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableCircuitRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/WritableCircuitRequest'
+ 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/PatchedWritableCircuitRequest'
+ 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/circuits/{id}/notes/:
+ get:
+ operationId: circuits_circuits_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this circuit.
+ 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:
+ - circuits
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: circuits_circuits_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /circuits/provider-networks/:
+ get:
+ operationId: circuits_provider_networks_list
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - circuits
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableProviderNetworkRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - circuits
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableProviderNetworkRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/ProviderNetwork'
+ description: ''
+ patch:
+ operationId: circuits_provider_networks_bulk_partial_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - circuits
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableProviderNetworkRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/ProviderNetwork'
+ description: ''
+ delete:
+ operationId: circuits_provider_networks_bulk_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - circuits
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /circuits/provider-networks/{id}/:
+ get:
+ operationId: circuits_provider_networks_retrieve
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/WritableProviderNetworkRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/PatchedWritableProviderNetworkRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/ProviderNetwork'
+ description: ''
+ delete:
+ operationId: circuits_provider_networks_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/provider-networks/{id}/notes/:
+ get:
+ operationId: circuits_provider_networks_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this provider network.
+ 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:
+ - circuits
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: circuits_provider_networks_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /circuits/providers/:
+ get:
+ operationId: circuits_providers_list
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: location
+ schema:
+ type: array
+ items:
+ type: string
+ description: Location (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: location__n
+ schema:
+ type: array
+ items:
+ type: string
+ description: Location (slug or 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 (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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - circuits
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ProviderRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - circuits
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableProviderRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/Provider'
+ description: ''
+ patch:
+ operationId: circuits_providers_bulk_partial_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - circuits
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableProviderRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/Provider'
+ description: ''
+ delete:
+ operationId: circuits_providers_bulk_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - circuits
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /circuits/providers/{id}/:
+ get:
+ operationId: circuits_providers_retrieve
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/ProviderRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/PatchedProviderRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Provider'
+ description: ''
+ delete:
+ operationId: circuits_providers_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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
+ /circuits/providers/{id}/notes/:
+ get:
+ operationId: circuits_providers_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this provider.
+ 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:
+ - circuits
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: circuits_providers_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /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__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: 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: region
+ schema:
+ type: array
+ items:
+ type: string
+ description: Region (name)
+ 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: 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: termination_a_id
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: termination_a_id__ic
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: termination_a_id__ie
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: termination_a_id__iew
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: termination_a_id__ire
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: termination_a_id__isw
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: termination_a_id__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: termination_a_id__nic
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: termination_a_id__nie
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: termination_a_id__niew
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: termination_a_id__nire
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: termination_a_id__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: termination_a_id__nre
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: termination_a_id__re
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: termination_a_type
+ schema:
+ type: array
+ items:
+ type: integer
+ explode: true
+ style: form
+ - in: query
+ name: termination_a_type__n
+ schema:
+ type: array
+ items:
+ type: integer
+ explode: true
+ style: form
+ - in: query
+ name: termination_b_id
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: termination_b_id__ic
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: termination_b_id__ie
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: termination_b_id__iew
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: termination_b_id__ire
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: termination_b_id__isw
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: termination_b_id__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: termination_b_id__nic
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: termination_b_id__nie
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: termination_b_id__niew
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: termination_b_id__nire
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: termination_b_id__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: termination_b_id__nre
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: termination_b_id__re
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: termination_b_type
+ schema:
+ type: array
+ items:
+ type: integer
+ explode: true
+ style: form
+ - in: query
+ name: termination_b_type__n
+ schema:
+ type: array
+ items:
+ type: integer
+ 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/WritableCableRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableCableRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableCableRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/WritableCableRequest'
+ 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/PatchedWritableCableRequest'
+ 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/cables/{id}/notes/:
+ get:
+ operationId: dcim_cables_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this cable.
+ 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:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: dcim_cables_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /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
+ - 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: 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ parameters:
+ - in: query
+ name: description
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__ic
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__ie
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__iew
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__ire
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__isw
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__n
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__nic
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__nie
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__niew
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__nire
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__nre
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__re
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: device_type
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Device type (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: device_type__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Device type (slug or ID)
+ 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
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__ic
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__ie
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__iew
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__ire
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__isw
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__nic
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__nie
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__niew
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__nire
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__nre
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__re
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: label
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__ic
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__ie
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__iew
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__ire
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__isw
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__n
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__nic
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__nie
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__niew
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__nire
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__nre
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__re
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ 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
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__ic
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__ie
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__iew
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__ire
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__isw
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__n
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__nic
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__nie
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__niew
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__nire
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__nre
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__re
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableConsolePortTemplateRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableConsolePortTemplateRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/ConsolePortTemplate'
+ description: ''
+ patch:
+ operationId: dcim_console_port_templates_bulk_partial_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableConsolePortTemplateRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/ConsolePortTemplate'
+ description: ''
+ delete:
+ operationId: dcim_console_port_templates_bulk_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /dcim/console-port-templates/{id}/:
+ get:
+ operationId: dcim_console_port_templates_retrieve
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/WritableConsolePortTemplateRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/PatchedWritableConsolePortTemplateRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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-port-templates/{id}/notes/:
+ get:
+ operationId: dcim_console_port_templates_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this console port template.
+ 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:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: dcim_console_port_templates_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /dcim/console-ports/:
+ get:
+ operationId: dcim_console_ports_list
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ parameters:
+ - in: query
+ name: cable
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Cable
+ explode: true
+ style: form
+ - in: query
+ name: cable__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Cable
+ 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
+ - 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
+ - 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableConsolePortRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableConsolePortRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/ConsolePort'
+ description: ''
+ patch:
+ operationId: dcim_console_ports_bulk_partial_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableConsolePortRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/ConsolePort'
+ description: ''
+ delete:
+ operationId: dcim_console_ports_bulk_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /dcim/console-ports/{id}/:
+ get:
+ operationId: dcim_console_ports_retrieve
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/WritableConsolePortRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/PatchedWritableConsolePortRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/ConsolePort'
+ description: ''
+ delete:
+ operationId: dcim_console_ports_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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}/notes/:
+ get:
+ operationId: dcim_console_ports_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this console port.
+ 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:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: dcim_console_ports_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ parameters:
+ - in: query
+ name: description
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__ic
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__ie
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__iew
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__ire
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__isw
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__n
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__nic
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__nie
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__niew
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__nire
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__nre
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__re
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: device_type
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Device type (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: device_type__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Device type (slug or ID)
+ 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
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__ic
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__ie
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__iew
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__ire
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__isw
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__nic
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__nie
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__niew
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__nire
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__nre
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__re
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: label
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__ic
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__ie
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__iew
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__ire
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__isw
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__n
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__nic
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__nie
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__niew
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__nire
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__nre
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__re
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ 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
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__ic
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__ie
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__iew
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__ire
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__isw
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__n
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__nic
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__nie
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__niew
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__nire
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__nre
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__re
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableConsoleServerPortTemplateRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableConsoleServerPortTemplateRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/ConsoleServerPortTemplate'
+ description: ''
+ patch:
+ operationId: dcim_console_server_port_templates_bulk_partial_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableConsoleServerPortTemplateRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/ConsoleServerPortTemplate'
+ description: ''
+ delete:
+ operationId: dcim_console_server_port_templates_bulk_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /dcim/console-server-port-templates/{id}/:
+ get:
+ operationId: dcim_console_server_port_templates_retrieve
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/WritableConsoleServerPortTemplateRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/PatchedWritableConsoleServerPortTemplateRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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-port-templates/{id}/notes/:
+ get:
+ operationId: dcim_console_server_port_templates_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this console server port template.
+ 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:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: dcim_console_server_port_templates_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /dcim/console-server-ports/:
+ get:
+ operationId: dcim_console_server_ports_list
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ parameters:
+ - in: query
+ name: cable
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Cable
+ explode: true
+ style: form
+ - in: query
+ name: cable__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Cable
+ 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
+ - 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
+ - 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableConsoleServerPortRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableConsoleServerPortRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/ConsoleServerPort'
+ description: ''
+ patch:
+ operationId: dcim_console_server_ports_bulk_partial_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableConsoleServerPortRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/ConsoleServerPort'
+ description: ''
+ delete:
+ operationId: dcim_console_server_ports_bulk_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /dcim/console-server-ports/{id}/:
+ get:
+ operationId: dcim_console_server_ports_retrieve
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/WritableConsoleServerPortRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/PatchedWritableConsoleServerPortRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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}/notes/:
+ get:
+ operationId: dcim_console_server_ports_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this console server port.
+ 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:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: dcim_console_server_ports_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ parameters:
+ - in: query
+ name: description
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__ic
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__ie
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__iew
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__ire
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__isw
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__n
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__nic
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__nie
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__niew
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__nire
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__nre
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__re
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: device_type
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Device type (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: device_type__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Device type (slug or ID)
+ 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
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__ic
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__ie
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__iew
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__ire
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__isw
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__nic
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__nie
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__niew
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__nire
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__nre
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__re
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: label
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__ic
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__ie
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__iew
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__ire
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__isw
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__n
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__nic
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__nie
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__niew
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__nire
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__nre
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__re
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ 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
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__ic
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__ie
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__iew
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__ire
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__isw
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__n
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__nic
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__nie
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__niew
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__nire
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__nre
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__re
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableDeviceBayTemplateRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableDeviceBayTemplateRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/DeviceBayTemplate'
+ description: ''
+ patch:
+ operationId: dcim_device_bay_templates_bulk_partial_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableDeviceBayTemplateRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/DeviceBayTemplate'
+ description: ''
+ delete:
+ operationId: dcim_device_bay_templates_bulk_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /dcim/device-bay-templates/{id}/:
+ get:
+ operationId: dcim_device_bay_templates_retrieve
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/WritableDeviceBayTemplateRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/PatchedWritableDeviceBayTemplateRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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-bay-templates/{id}/notes/:
+ get:
+ operationId: dcim_device_bay_templates_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this device bay template.
+ 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:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: dcim_device_bay_templates_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /dcim/device-bays/:
+ get:
+ operationId: dcim_device_bays_list
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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
+ - in: query
+ name: installed_device
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Installed device (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: installed_device__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Installed device (name or ID)
+ 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
+ - 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableDeviceBayRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableDeviceBayRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/DeviceBay'
+ description: ''
+ patch:
+ operationId: dcim_device_bays_bulk_partial_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableDeviceBayRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/DeviceBay'
+ description: ''
+ delete:
+ operationId: dcim_device_bays_bulk_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /dcim/device-bays/{id}/:
+ get:
+ operationId: dcim_device_bays_retrieve
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/WritableDeviceBayRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/PatchedWritableDeviceBayRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/DeviceBay'
+ description: ''
+ delete:
+ operationId: dcim_device_bays_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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-bays/{id}/notes/:
+ get:
+ operationId: dcim_device_bays_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this device bay.
+ 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:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: dcim_device_bays_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /dcim/device-redundancy-groups/:
+ get:
+ operationId: dcim_device_redundancy_groups_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: failover_strategy
+ schema:
+ type: string
+ - in: query
+ name: failover_strategy__n
+ schema:
+ type: string
+ - 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: secrets_group
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Secrets group
+ explode: true
+ style: form
+ - in: query
+ name: secrets_group__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Secrets group
+ 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
+ tags:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedDeviceRedundancyGroupList'
+ description: ''
+ post:
+ operationId: dcim_device_redundancy_groups_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/WritableDeviceRedundancyGroupRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/DeviceRedundancyGroup'
+ description: ''
+ put:
+ operationId: dcim_device_redundancy_groups_bulk_update
+ description: Mixin to set `metadata_class` to implement `status` field in model
+ viewset metadata.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableDeviceRedundancyGroupRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/DeviceRedundancyGroup'
+ description: ''
+ patch:
+ operationId: dcim_device_redundancy_groups_bulk_partial_update
+ description: Mixin to set `metadata_class` to implement `status` field in model
+ viewset metadata.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableDeviceRedundancyGroupRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/DeviceRedundancyGroup'
+ description: ''
+ delete:
+ operationId: dcim_device_redundancy_groups_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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /dcim/device-redundancy-groups/{id}/:
+ get:
+ operationId: dcim_device_redundancy_groups_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 device redundancy group.
+ required: true
+ tags:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/DeviceRedundancyGroup'
+ description: ''
+ put:
+ operationId: dcim_device_redundancy_groups_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 device redundancy group.
+ required: true
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableDeviceRedundancyGroupRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/DeviceRedundancyGroup'
+ description: ''
+ patch:
+ operationId: dcim_device_redundancy_groups_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 device redundancy group.
+ required: true
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PatchedWritableDeviceRedundancyGroupRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/DeviceRedundancyGroup'
+ description: ''
+ delete:
+ operationId: dcim_device_redundancy_groups_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 device redundancy group.
+ required: true
+ tags:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ /dcim/device-redundancy-groups/{id}/notes/:
+ get:
+ operationId: dcim_device_redundancy_groups_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this device redundancy group.
+ 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:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: dcim_device_redundancy_groups_notes_create
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this device redundancy group.
+ required: true
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /dcim/device-roles/:
+ get:
+ operationId: dcim_device_roles_list
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: 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: devices
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: devices__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: has_devices
+ schema:
+ type: boolean
+ description: Has devices
+ - in: query
+ name: has_virtual_machines
+ schema:
+ type: boolean
+ description: Has virtual machines
+ - 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: virtual_machines
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: virtual_machines__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DeviceRoleRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableDeviceRoleRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/DeviceRole'
+ description: ''
+ patch:
+ operationId: dcim_device_roles_bulk_partial_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableDeviceRoleRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/DeviceRole'
+ description: ''
+ delete:
+ operationId: dcim_device_roles_bulk_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /dcim/device-roles/{id}/:
+ get:
+ operationId: dcim_device_roles_retrieve
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/DeviceRoleRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/PatchedDeviceRoleRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/DeviceRole'
+ description: ''
+ delete:
+ operationId: dcim_device_roles_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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-roles/{id}/notes/:
+ get:
+ operationId: dcim_device_roles_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this device role.
+ 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:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: dcim_device_roles_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /dcim/device-types/:
+ get:
+ operationId: dcim_device_types_list
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ parameters:
+ - in: query
+ name: comments
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__ic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__ie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__iew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__ire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__isw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__n
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__nic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__nie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__niew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__nire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__nre
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__re
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: console_port_templates
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Console port templates (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: console_port_templates__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Console port templates (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: console_ports
+ schema:
+ type: boolean
+ description: Has console ports
+ - in: query
+ name: console_server_port_templates
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Console server port templates (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: console_server_port_templates__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Console server port templates (name or ID)
+ explode: true
+ style: form
+ - 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_bay_templates
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Device bay templates
+ explode: true
+ style: form
+ - in: query
+ name: device_bay_templates__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Device bay templates
+ explode: true
+ style: form
+ - in: query
+ name: device_bays
+ schema:
+ type: boolean
+ description: Has device bays
+ - in: query
+ name: front_port_templates
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Front port templates (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: front_port_templates__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Front port templates (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: has_console_port_templates
+ schema:
+ type: boolean
+ description: Has console port templates
+ - in: query
+ name: has_console_server_port_templates
+ schema:
+ type: boolean
+ description: Has console server port templates
+ - in: query
+ name: has_device_bay_templates
+ schema:
+ type: boolean
+ description: Has device bay templates
+ - in: query
+ name: has_front_port_templates
+ schema:
+ type: boolean
+ description: Has front port templates
+ - in: query
+ name: has_instances
+ schema:
+ type: boolean
+ description: Has instances
+ - in: query
+ name: has_interface_templates
+ schema:
+ type: boolean
+ description: Has interface templates
+ - in: query
+ name: has_power_outlet_templates
+ schema:
+ type: boolean
+ description: Has power outlet templates
+ - in: query
+ name: has_power_port_templates
+ schema:
+ type: boolean
+ description: Has power port templates
+ - in: query
+ name: has_rear_port_templates
+ schema:
+ type: boolean
+ description: Has rear port templates
+ - 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: instances
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: instances__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: interface_templates
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Interface templates (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: interface_templates__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Interface templates (name or ID)
+ 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_outlet_templates
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Power outlet templates (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: power_outlet_templates__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Power outlet templates (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: power_outlets
+ schema:
+ type: boolean
+ description: Has power outlets
+ - in: query
+ name: power_port_templates
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Power port templates (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: power_port_templates__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Power port templates (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: power_ports
+ schema:
+ type: boolean
+ description: Has power ports
+ - in: query
+ name: q
+ schema:
+ type: string
+ description: Search
+ - in: query
+ name: rear_port_templates
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Rear port templates (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: rear_port_templates__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Rear port templates (name or 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: 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableDeviceTypeRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableDeviceTypeRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/DeviceType'
+ description: ''
+ patch:
+ operationId: dcim_device_types_bulk_partial_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableDeviceTypeRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/DeviceType'
+ description: ''
+ delete:
+ operationId: dcim_device_types_bulk_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /dcim/device-types/{id}/:
+ get:
+ operationId: dcim_device_types_retrieve
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/WritableDeviceTypeRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/PatchedWritableDeviceTypeRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/DeviceType'
+ description: ''
+ delete:
+ operationId: dcim_device_types_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/device-types/{id}/notes/:
+ get:
+ operationId: dcim_device_types_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this device type.
+ 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:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: dcim_device_types_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /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:
+ - name: asset_tag
+ required: false
+ in: query
+ description: asset_tag
+ schema:
+ type: string
+ - name: asset_tag__ic
+ required: false
+ in: query
+ description: asset_tag__ic
+ schema:
+ type: string
+ - name: asset_tag__ie
+ required: false
+ in: query
+ description: asset_tag__ie
+ schema:
+ type: string
+ - name: asset_tag__iew
+ required: false
+ in: query
+ description: asset_tag__iew
+ schema:
+ type: string
+ - name: asset_tag__ire
+ required: false
+ in: query
+ description: asset_tag__ire
+ schema:
+ type: string
+ - name: asset_tag__isw
+ required: false
+ in: query
+ description: asset_tag__isw
+ schema:
+ type: string
+ - name: asset_tag__n
+ required: false
+ in: query
+ description: asset_tag__n
+ schema:
+ type: string
+ - name: asset_tag__nic
+ required: false
+ in: query
+ description: asset_tag__nic
+ schema:
+ type: string
+ - name: asset_tag__nie
+ required: false
+ in: query
+ description: asset_tag__nie
+ schema:
+ type: string
+ - name: asset_tag__niew
+ required: false
+ in: query
+ description: asset_tag__niew
+ schema:
+ type: string
+ - name: asset_tag__nire
+ required: false
+ in: query
+ description: asset_tag__nire
+ schema:
+ type: string
+ - name: asset_tag__nisw
+ required: false
+ in: query
+ description: asset_tag__nisw
+ schema:
+ type: string
+ - name: asset_tag__nre
+ required: false
+ in: query
+ description: asset_tag__nre
+ schema:
+ type: string
+ - name: asset_tag__re
+ required: false
+ in: query
+ description: asset_tag__re
+ schema:
+ type: string
+ - name: cluster_id
+ required: false
+ in: query
+ description: VM cluster (ID)
+ schema:
+ type: string
+ - name: cluster_id__n
+ required: false
+ in: query
+ description: VM cluster (ID)
+ schema:
+ type: string
+ - name: console_ports
+ required: false
+ in: query
+ description: Has console ports
+ schema:
+ type: string
+ - name: console_server_ports
+ required: false
+ in: query
+ description: Has console server ports
+ schema:
+ type: string
+ - name: created
+ required: false
+ in: query
+ description: created
+ schema:
+ type: string
+ - name: created__gte
+ required: false
+ in: query
+ description: created__gte
+ schema:
+ type: string
+ - name: created__lte
+ required: false
+ in: query
+ description: created__lte
+ schema:
+ type: string
+ - name: device_bays
+ required: false
+ in: query
+ description: Has device bays
+ schema:
+ type: string
+ - name: device_redundancy_group
+ required: false
+ in: query
+ description: Device Redundancy Groups (slug or ID)
+ schema:
+ type: string
+ - name: device_redundancy_group__n
+ required: false
+ in: query
+ description: Device Redundancy Groups (slug or ID)
+ schema:
+ type: string
+ - name: device_redundancy_group_priority
+ required: false
+ in: query
+ description: device_redundancy_group_priority
+ schema:
+ type: string
+ - name: device_redundancy_group_priority__gt
+ required: false
+ in: query
+ description: device_redundancy_group_priority__gt
+ schema:
+ type: string
+ - name: device_redundancy_group_priority__gte
+ required: false
+ in: query
+ description: device_redundancy_group_priority__gte
+ schema:
+ type: string
+ - name: device_redundancy_group_priority__lt
+ required: false
+ in: query
+ description: device_redundancy_group_priority__lt
+ schema:
+ type: string
+ - name: device_redundancy_group_priority__lte
+ required: false
+ in: query
+ description: device_redundancy_group_priority__lte
+ schema:
+ type: string
+ - name: device_redundancy_group_priority__n
+ required: false
+ in: query
+ description: device_redundancy_group_priority__n
+ schema:
+ type: string
+ - name: device_type_id
+ required: false
+ in: query
+ description: Device type (ID)
+ schema:
+ type: string
+ - name: device_type_id__n
+ required: false
+ in: query
+ description: Device type (ID)
+ schema:
+ type: string
+ - name: face
+ required: false
+ in: query
+ description: face
+ schema:
+ type: string
+ enum:
+ - front
+ - rear
+ - name: face__n
+ required: false
+ in: query
+ description: face__n
+ schema:
+ type: string
+ enum:
+ - front
+ - rear
+ - name: has_console_ports
+ required: false
+ in: query
+ description: Has console ports
+ schema:
+ type: string
+ - name: has_console_server_ports
+ required: false
+ in: query
+ description: Has console server ports
+ schema:
+ type: string
+ - name: has_device_bays
+ required: false
+ in: query
+ description: Has device bays
+ schema:
+ type: string
+ - name: has_front_ports
+ required: false
+ in: query
+ description: Has front ports
+ schema:
+ type: string
+ - name: has_interfaces
+ required: false
+ in: query
+ description: Has interfaces
+ schema:
+ type: string
+ - name: has_power_outlets
+ required: false
+ in: query
+ description: Has power outlets
+ schema:
+ type: string
+ - name: has_power_ports
+ required: false
+ in: query
+ description: Has power ports
+ schema:
+ type: string
+ - name: has_primary_ip
+ required: false
+ in: query
+ description: Has a primary IP
+ schema:
+ type: string
+ - name: has_rear_ports
+ required: false
+ in: query
+ description: Has rear ports
+ schema:
+ type: string
+ - name: id
+ required: false
+ in: query
+ description: id
+ schema:
+ type: string
+ - name: id__ic
+ required: false
+ in: query
+ description: id__ic
+ schema:
+ type: string
+ - name: id__ie
+ required: false
+ in: query
+ description: id__ie
+ schema:
+ type: string
+ - name: id__iew
+ required: false
+ in: query
+ description: id__iew
+ schema:
+ type: string
+ - name: id__ire
+ required: false
+ in: query
+ description: id__ire
+ schema:
+ type: string
+ - name: id__isw
+ required: false
+ in: query
+ description: id__isw
+ schema:
+ type: string
+ - name: id__n
+ required: false
+ in: query
+ description: id__n
+ schema:
+ type: string
+ - name: id__nic
+ required: false
+ in: query
+ description: id__nic
+ schema:
+ type: string
+ - name: id__nie
+ required: false
+ in: query
+ description: id__nie
+ schema:
+ type: string
+ - name: id__niew
+ required: false
+ in: query
+ description: id__niew
+ schema:
+ type: string
+ - name: id__nire
+ required: false
+ in: query
+ description: id__nire
+ schema:
+ type: string
+ - name: id__nisw
+ required: false
+ in: query
+ description: id__nisw
+ schema:
+ type: string
+ - name: id__nre
+ required: false
+ in: query
+ description: id__nre
+ schema:
+ type: string
+ - name: id__re
+ required: false
+ in: query
+ description: id__re
+ schema:
+ type: string
+ - name: interfaces
+ required: false
+ in: query
+ description: Has interfaces
+ schema:
+ type: string
+ - name: is_full_depth
+ required: false
+ in: query
+ description: Is full depth
+ schema:
+ type: string
+ - name: is_virtual_chassis_member
+ required: false
+ in: query
+ description: Is a virtual chassis member
+ schema:
+ type: string
+ - name: last_updated
+ required: false
+ in: query
+ description: last_updated
+ schema:
+ type: string
+ - name: last_updated__gte
+ required: false
+ in: query
+ description: last_updated__gte
+ schema:
+ type: string
+ - name: last_updated__lte
+ required: false
+ in: query
+ description: last_updated__lte
+ schema:
+ type: string
+ - name: limit
+ required: false
+ in: query
+ description: Number of results to return per page.
+ schema:
+ type: integer
+ - name: local_context_data
+ required: false
+ in: query
+ description: Has local config context data
+ schema:
+ type: string
+ - name: local_context_schema
+ required: false
+ in: query
+ description: Schema (slug)
+ schema:
+ type: string
+ - name: local_context_schema__n
+ required: false
+ in: query
+ description: Schema (slug)
+ schema:
+ type: string
+ - name: local_context_schema_id
+ required: false
+ in: query
+ description: Schema (ID)
+ schema:
+ type: string
+ - name: local_context_schema_id__n
+ required: false
+ in: query
+ description: Schema (ID)
+ schema:
+ type: string
+ - name: location
+ required: false
+ in: query
+ description: Location (slug or ID)
+ schema:
+ type: string
+ - name: location__n
+ required: false
+ in: query
+ description: Location (slug or ID)
+ schema:
+ type: string
+ - name: mac_address
+ required: false
+ in: query
+ description: MAC address
+ schema:
+ type: string
+ - name: mac_address__ic
+ required: false
+ in: query
+ description: MAC address
+ schema:
+ type: string
+ - name: mac_address__ie
+ required: false
+ in: query
+ description: MAC address
+ schema:
+ type: string
+ - name: mac_address__iew
+ required: false
+ in: query
+ description: MAC address
+ schema:
+ type: string
+ - name: mac_address__ire
+ required: false
+ in: query
+ description: MAC address
+ schema:
+ type: string
+ - name: mac_address__isw
+ required: false
+ in: query
+ description: MAC address
+ schema:
+ type: string
+ - name: mac_address__n
+ required: false
+ in: query
+ description: MAC address
+ schema:
+ type: string
+ - name: mac_address__nic
+ required: false
+ in: query
+ description: MAC address
+ schema:
+ type: string
+ - name: mac_address__nie
+ required: false
+ in: query
+ description: MAC address
+ schema:
+ type: string
+ - name: mac_address__niew
+ required: false
+ in: query
+ description: MAC address
+ schema:
+ type: string
+ - name: mac_address__nire
+ required: false
+ in: query
+ description: MAC address
+ schema:
+ type: string
+ - name: mac_address__nisw
+ required: false
+ in: query
+ description: MAC address
+ schema:
+ type: string
+ - name: mac_address__nre
+ required: false
+ in: query
+ description: MAC address
+ schema:
+ type: string
+ - name: mac_address__re
+ required: false
+ in: query
+ description: MAC address
+ schema:
+ type: string
+ - name: manufacturer
+ required: false
+ in: query
+ description: Manufacturer (slug)
+ schema:
+ type: string
+ - name: manufacturer__n
+ required: false
+ in: query
+ description: Manufacturer (slug)
+ schema:
+ type: string
+ - name: manufacturer_id
+ required: false
+ in: query
+ description: Manufacturer (ID)
+ schema:
+ type: string
+ - name: manufacturer_id__n
+ required: false
+ in: query
+ description: Manufacturer (ID)
+ schema:
+ type: string
+ - name: model
+ required: false
+ in: query
+ description: Device model (slug)
+ schema:
+ type: string
+ - name: model__n
+ required: false
+ in: query
+ description: Device model (slug)
+ schema:
+ type: string
+ - name: name
+ required: false
+ in: query
+ description: name
+ schema:
+ type: string
+ - name: name__ic
+ required: false
+ in: query
+ description: name__ic
+ schema:
+ type: string
+ - name: name__ie
+ required: false
+ in: query
+ description: name__ie
+ schema:
+ type: string
+ - name: name__iew
+ required: false
+ in: query
+ description: name__iew
+ schema:
+ type: string
+ - name: name__ire
+ required: false
+ in: query
+ description: name__ire
+ schema:
+ type: string
+ - name: name__isw
+ required: false
+ in: query
+ description: name__isw
+ schema:
+ type: string
+ - name: name__n
+ required: false
+ in: query
+ description: name__n
+ schema:
+ type: string
+ - name: name__nic
+ required: false
+ in: query
+ description: name__nic
+ schema:
+ type: string
+ - name: name__nie
+ required: false
+ in: query
+ description: name__nie
+ schema:
+ type: string
+ - name: name__niew
+ required: false
+ in: query
+ description: name__niew
+ schema:
+ type: string
+ - name: name__nire
+ required: false
+ in: query
+ description: name__nire
+ schema:
+ type: string
+ - name: name__nisw
+ required: false
+ in: query
+ description: name__nisw
+ schema:
+ type: string
+ - name: name__nre
+ required: false
+ in: query
+ description: name__nre
+ schema:
+ type: string
+ - name: name__re
+ required: false
+ in: query
+ description: name__re
+ schema:
+ type: string
+ - name: offset
+ required: false
+ in: query
+ description: The initial index from which to return the results.
+ schema:
+ type: integer
+ - name: pass_through_ports
+ required: false
+ in: query
+ description: Has pass-through ports
+ schema:
+ type: string
+ - name: platform
+ required: false
+ in: query
+ description: Platform (slug)
+ schema:
+ type: string
+ - name: platform__n
+ required: false
+ in: query
+ description: Platform (slug)
+ schema:
+ type: string
+ - name: platform_id
+ required: false
+ in: query
+ description: Platform (ID)
+ schema:
+ type: string
+ - name: platform_id__n
+ required: false
+ in: query
+ description: Platform (ID)
+ schema:
+ type: string
+ - name: position
+ required: false
+ in: query
+ description: position
+ schema:
+ type: string
+ - name: position__gt
+ required: false
+ in: query
+ description: position__gt
+ schema:
+ type: string
+ - name: position__gte
+ required: false
+ in: query
+ description: position__gte
+ schema:
+ type: string
+ - name: position__lt
+ required: false
+ in: query
+ description: position__lt
+ schema:
+ type: string
+ - name: position__lte
+ required: false
+ in: query
+ description: position__lte
+ schema:
+ type: string
+ - name: position__n
+ required: false
+ in: query
+ description: position__n
+ schema:
+ type: string
+ - name: power_outlets
+ required: false
+ in: query
+ description: Has power outlets
+ schema:
+ type: string
+ - name: power_ports
+ required: false
+ in: query
+ description: Has power ports
+ schema:
+ type: string
+ - name: q
+ required: false
+ in: query
+ description: Search
+ schema:
+ type: string
+ - name: rack_group_id
+ required: false
+ in: query
+ description: Rack group (ID)
+ schema:
+ type: string
+ - name: rack_group_id__n
+ required: false
+ in: query
+ description: Rack group (ID)
+ schema:
+ type: string
+ - name: rack_id
+ required: false
+ in: query
+ description: Rack (ID)
+ schema:
+ type: string
+ - name: rack_id__n
+ required: false
+ in: query
+ description: Rack (ID)
+ schema:
+ type: string
+ - name: region
+ required: false
+ in: query
+ description: Region (slug or ID)
+ schema:
+ type: string
+ - name: region__n
+ required: false
+ in: query
+ description: Region (slug or ID)
+ schema:
+ type: string
+ - name: region_id
+ required: false
+ in: query
+ description: Region (ID) (deprecated, use "region" filter instead)
+ schema:
+ type: string
+ - name: region_id__n
+ required: false
+ in: query
+ description: Region (ID) (deprecated, use "region" filter instead)
+ schema:
+ type: string
+ - name: role
+ required: false
+ in: query
+ description: Role (slug)
+ schema:
+ type: string
+ - name: role__n
+ required: false
+ in: query
+ description: Role (slug)
+ schema:
+ type: string
+ - name: role_id
+ required: false
+ in: query
+ description: Role (ID)
+ schema:
+ type: string
+ - name: role_id__n
+ required: false
+ in: query
+ description: Role (ID)
+ schema:
+ type: string
+ - name: secrets_group
+ required: false
+ in: query
+ description: Secrets group (slug)
+ schema:
+ type: string
+ - name: secrets_group__n
+ required: false
+ in: query
+ description: Secrets group (slug)
+ schema:
+ type: string
+ - name: secrets_group_id
+ required: false
+ in: query
+ description: Secrets group (ID)
+ schema:
+ type: string
+ - name: secrets_group_id__n
+ required: false
+ in: query
+ description: Secrets group (ID)
+ schema:
+ type: string
+ - name: serial
+ required: false
+ in: query
+ description: serial
+ schema:
+ type: string
+ - name: site
+ required: false
+ in: query
+ description: Site (slug or ID)
+ schema:
+ type: string
+ - name: site__n
+ required: false
+ in: query
+ description: Site (slug or ID)
+ schema:
+ type: string
+ - name: site_id
+ required: false
+ in: query
+ description: Site (ID) (deprecated, use "site" filter instead)
+ schema:
+ type: string
+ - name: site_id__n
+ required: false
+ in: query
+ description: Site (ID) (deprecated, use "site" filter instead)
+ schema:
+ type: string
+ - name: status
+ required: false
+ in: query
+ description: status
+ schema:
+ type: string
+ - name: status__n
+ required: false
+ in: query
+ description: status__n
+ schema:
+ type: string
+ - name: tag
+ required: false
+ in: query
+ description: tag
+ schema:
+ type: string
+ - name: tag__n
+ required: false
+ in: query
+ description: tag__n
+ schema:
+ type: string
+ - name: tenant
+ required: false
+ in: query
+ description: Tenant (slug or ID)
+ schema:
+ type: string
+ - name: tenant__n
+ required: false
+ in: query
+ description: Tenant (slug or ID)
+ schema:
+ type: string
+ - name: tenant_group
+ required: false
+ in: query
+ description: Tenant Group (slug)
+ schema:
+ type: string
+ - name: tenant_group__n
+ required: false
+ in: query
+ description: Tenant Group (slug)
+ schema:
+ type: string
+ - name: tenant_group_id
+ required: false
+ in: query
+ description: Tenant Group (ID)
+ schema:
+ type: string
+ - name: tenant_group_id__n
+ required: false
+ in: query
+ description: Tenant Group (ID)
+ schema:
+ type: string
+ - name: tenant_id
+ required: false
+ in: query
+ description: Tenant (ID) (deprecated, use "tenant" filter instead)
+ schema:
+ type: string
+ - name: tenant_id__n
+ required: false
+ in: query
+ description: Tenant (ID) (deprecated, use "tenant" filter instead)
+ schema:
+ type: string
+ - name: vc_position
+ required: false
+ in: query
+ description: vc_position
+ schema:
+ type: string
+ - name: vc_position__gt
+ required: false
+ in: query
+ description: vc_position__gt
+ schema:
+ type: string
+ - name: vc_position__gte
+ required: false
+ in: query
+ description: vc_position__gte
+ schema:
+ type: string
+ - name: vc_position__lt
+ required: false
+ in: query
+ description: vc_position__lt
+ schema:
+ type: string
+ - name: vc_position__lte
+ required: false
+ in: query
+ description: vc_position__lte
+ schema:
+ type: string
+ - name: vc_position__n
+ required: false
+ in: query
+ description: vc_position__n
+ schema:
+ type: string
+ - name: vc_priority
+ required: false
+ in: query
+ description: vc_priority
+ schema:
+ type: string
+ - name: vc_priority__gt
+ required: false
+ in: query
+ description: vc_priority__gt
+ schema:
+ type: string
+ - name: vc_priority__gte
+ required: false
+ in: query
+ description: vc_priority__gte
+ schema:
+ type: string
+ - name: vc_priority__lt
+ required: false
+ in: query
+ description: vc_priority__lt
+ schema:
+ type: string
+ - name: vc_priority__lte
+ required: false
+ in: query
+ description: vc_priority__lte
+ schema:
+ type: string
+ - name: vc_priority__n
+ required: false
+ in: query
+ description: vc_priority__n
+ schema:
+ type: string
+ - name: virtual_chassis_id
+ required: false
+ in: query
+ description: Virtual chassis (ID)
+ schema:
+ type: string
+ - name: virtual_chassis_id__n
+ required: false
+ in: query
+ description: Virtual chassis (ID)
+ schema:
+ type: string
+ - name: virtual_chassis_member
+ required: false
+ in: query
+ description: Is a virtual chassis member
+ schema:
+ type: string
+ 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/WritableDeviceWithConfigContextRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableDeviceWithConfigContextRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableDeviceWithConfigContextRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/WritableDeviceWithConfigContextRequest'
+ 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/PatchedWritableDeviceWithConfigContextRequest'
+ 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/devices/{id}/notes/:
+ get:
+ operationId: dcim_devices_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this device.
+ 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:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: dcim_devices_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /dcim/front-port-templates/:
+ get:
+ operationId: dcim_front_port_templates_list
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ parameters:
+ - in: query
+ name: description
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__ic
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__ie
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__iew
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__ire
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__isw
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__n
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__nic
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__nie
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__niew
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__nire
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__nre
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__re
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: device_type
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Device type (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: device_type__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Device type (slug or ID)
+ 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
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__ic
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__ie
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__iew
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__ire
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__isw
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__nic
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__nie
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__niew
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__nire
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__nre
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__re
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: label
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__ic
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__ie
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__iew
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__ire
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__isw
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__n
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__nic
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__nie
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__niew
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__nire
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__nre
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__re
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ 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
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__ic
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__ie
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__iew
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__ire
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__isw
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__n
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__nic
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__nie
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__niew
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__nire
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__nre
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__re
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ 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: rear_port_position
+ schema:
+ type: array
+ items:
+ type: integer
+ explode: true
+ style: form
+ - in: query
+ name: rear_port_position__gt
+ schema:
+ type: array
+ items:
+ type: integer
+ explode: true
+ style: form
+ - in: query
+ name: rear_port_position__gte
+ schema:
+ type: array
+ items:
+ type: integer
+ explode: true
+ style: form
+ - in: query
+ name: rear_port_position__lt
+ schema:
+ type: array
+ items:
+ type: integer
+ explode: true
+ style: form
+ - in: query
+ name: rear_port_position__lte
+ schema:
+ type: array
+ items:
+ type: integer
+ explode: true
+ style: form
+ - in: query
+ name: rear_port_position__n
+ schema:
+ type: array
+ items:
+ type: integer
+ explode: true
+ style: form
+ - in: query
+ name: rear_port_template
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Rear port template
+ explode: true
+ style: form
+ - in: query
+ name: rear_port_template__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Rear port template
+ 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/PaginatedFrontPortTemplateList'
+ description: ''
+ post:
+ operationId: dcim_front_port_templates_create
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableFrontPortTemplateRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableFrontPortTemplateRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/FrontPortTemplate'
+ description: ''
+ patch:
+ operationId: dcim_front_port_templates_bulk_partial_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableFrontPortTemplateRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/FrontPortTemplate'
+ description: ''
+ delete:
+ operationId: dcim_front_port_templates_bulk_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /dcim/front-port-templates/{id}/:
+ get:
+ operationId: dcim_front_port_templates_retrieve
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/WritableFrontPortTemplateRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/PatchedWritableFrontPortTemplateRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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-port-templates/{id}/notes/:
+ get:
+ operationId: dcim_front_port_templates_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this front port template.
+ 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:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: dcim_front_port_templates_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /dcim/front-ports/:
+ get:
+ operationId: dcim_front_ports_list
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ parameters:
+ - in: query
+ name: cable
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Cable
+ explode: true
+ style: form
+ - in: query
+ name: cable__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Cable
+ explode: true
+ style: form
+ - 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
+ - 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
+ - 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: rear_port
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Rear port (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: rear_port__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Rear port (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: rear_port_position
+ schema:
+ type: array
+ items:
+ type: integer
+ explode: true
+ style: form
+ - in: query
+ name: rear_port_position__gt
+ schema:
+ type: array
+ items:
+ type: integer
+ explode: true
+ style: form
+ - in: query
+ name: rear_port_position__gte
+ schema:
+ type: array
+ items:
+ type: integer
+ explode: true
+ style: form
+ - in: query
+ name: rear_port_position__lt
+ schema:
+ type: array
+ items:
+ type: integer
+ explode: true
+ style: form
+ - in: query
+ name: rear_port_position__lte
+ schema:
+ type: array
+ items:
+ type: integer
+ explode: true
+ style: form
+ - in: query
+ name: rear_port_position__n
+ schema:
+ type: array
+ items:
+ type: integer
+ 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
+ - 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableFrontPortRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableFrontPortRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/FrontPort'
+ description: ''
+ patch:
+ operationId: dcim_front_ports_bulk_partial_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableFrontPortRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/FrontPort'
+ description: ''
+ delete:
+ operationId: dcim_front_ports_bulk_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /dcim/front-ports/{id}/:
+ get:
+ operationId: dcim_front_ports_retrieve
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/WritableFrontPortRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/PatchedWritableFrontPortRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/FrontPort'
+ description: ''
+ delete:
+ operationId: dcim_front_ports_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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}/notes/:
+ get:
+ operationId: dcim_front_ports_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this front port.
+ 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:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: dcim_front_ports_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /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
+ - 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: 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ parameters:
+ - in: query
+ name: description
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__ic
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__ie
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__iew
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__ire
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__isw
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__n
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__nic
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__nie
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__niew
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__nire
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__nre
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__re
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: device_type
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Device type (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: device_type__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Device type (slug or ID)
+ 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
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__ic
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__ie
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__iew
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__ire
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__isw
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__nic
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__nie
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__niew
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__nire
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__nre
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__re
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: label
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__ic
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__ie
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__iew
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__ire
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__isw
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__n
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__nic
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__nie
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__niew
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__nire
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__nre
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__re
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ 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
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__ic
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__ie
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__iew
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__ire
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__isw
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__n
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__nic
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__nie
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__niew
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__nire
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__nre
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__re
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableInterfaceTemplateRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableInterfaceTemplateRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/InterfaceTemplate'
+ description: ''
+ patch:
+ operationId: dcim_interface_templates_bulk_partial_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableInterfaceTemplateRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/InterfaceTemplate'
+ description: ''
+ delete:
+ operationId: dcim_interface_templates_bulk_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /dcim/interface-templates/{id}/:
+ get:
+ operationId: dcim_interface_templates_retrieve
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/WritableInterfaceTemplateRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/PatchedWritableInterfaceTemplateRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/InterfaceTemplate'
+ description: ''
+ delete:
+ operationId: dcim_interface_templates_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/interface-templates/{id}/notes/:
+ get:
+ operationId: dcim_interface_templates_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this interface template.
+ 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:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: dcim_interface_templates_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /dcim/interfaces/:
+ get:
+ operationId: dcim_interfaces_list
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ parameters:
+ - in: query
+ name: bridge
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Bridge interface (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: bridge__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Bridge interface (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: bridged_interfaces
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Bridged interfaces (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: bridged_interfaces__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Bridged interfaces (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: cable
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Cable
+ explode: true
+ style: form
+ - in: query
+ name: cable__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Cable
+ explode: true
+ style: form
+ - in: query
+ name: cabled
+ schema:
+ type: boolean
+ - in: query
+ name: child_interfaces
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Child interfaces (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: child_interfaces__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Child interfaces (name or ID)
+ explode: true
+ style: form
+ - 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: device_with_common_vc
+ schema:
+ type: string
+ format: uuid
+ description: Virtual Chassis member Device (ID)
+ - in: query
+ name: enabled
+ schema:
+ type: boolean
+ - in: query
+ name: has_bridged_interfaces
+ schema:
+ type: boolean
+ description: Has bridged interfaces
+ - in: query
+ name: has_child_interfaces
+ schema:
+ type: boolean
+ description: Has child interfaces
+ - in: query
+ name: has_member_interfaces
+ schema:
+ type: boolean
+ description: Has member interfaces
+ - in: query
+ name: has_tagged_vlans
+ schema:
+ type: boolean
+ description: Has tagged VLANs
+ - 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: 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: lag
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: LAG interface (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: lag__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: LAG interface (name or ID)
+ explode: true
+ style: form
+ - 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: member_interfaces
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Member interfaces (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: member_interfaces__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Member interfaces (name or ID)
+ 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
+ - in: query
+ name: nautobot_bgp_models_interfaces_bgp_routing_instance
+ schema:
+ type: array
+ items:
+ type: string
+ description: Routing Instance UUID
+ explode: true
+ style: form
+ - in: query
+ name: nautobot_bgp_models_interfaces_bgp_routing_instance__ic
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: nautobot_bgp_models_interfaces_bgp_routing_instance__ie
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: nautobot_bgp_models_interfaces_bgp_routing_instance__iew
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: nautobot_bgp_models_interfaces_bgp_routing_instance__ire
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: nautobot_bgp_models_interfaces_bgp_routing_instance__isw
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: nautobot_bgp_models_interfaces_bgp_routing_instance__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: nautobot_bgp_models_interfaces_bgp_routing_instance__nic
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: nautobot_bgp_models_interfaces_bgp_routing_instance__nie
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: nautobot_bgp_models_interfaces_bgp_routing_instance__niew
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: nautobot_bgp_models_interfaces_bgp_routing_instance__nire
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: nautobot_bgp_models_interfaces_bgp_routing_instance__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: nautobot_bgp_models_interfaces_bgp_routing_instance__nre
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: nautobot_bgp_models_interfaces_bgp_routing_instance__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
+ - in: query
+ name: parent_interface
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Parent interface (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: parent_interface__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Parent interface (name or 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 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: tagged_vlans
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Tagged VLANs (VID or ID)
+ explode: true
+ style: form
+ - in: query
+ name: tagged_vlans__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Tagged VLANs (VID or 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: untagged_vlan
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Untagged VLAN (VID or ID)
+ explode: true
+ style: form
+ - in: query
+ name: untagged_vlan__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Untagged VLAN (VID or ID)
+ 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/PaginatedInterfaceSerializerVersion12List'
+ description: ''
+ post:
+ operationId: dcim_interfaces_create
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableInterfaceRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/InterfaceSerializerVersion12'
+ description: ''
+ put:
+ operationId: dcim_interfaces_bulk_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableInterfaceRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/InterfaceSerializerVersion12'
+ description: ''
+ patch:
+ operationId: dcim_interfaces_bulk_partial_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableInterfaceRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/InterfaceSerializerVersion12'
+ description: ''
+ delete:
+ operationId: dcim_interfaces_bulk_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /dcim/interfaces/{id}/:
+ get:
+ operationId: dcim_interfaces_retrieve
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/InterfaceSerializerVersion12'
+ description: ''
+ put:
+ operationId: dcim_interfaces_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/WritableInterfaceRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/InterfaceSerializerVersion12'
+ description: ''
+ patch:
+ operationId: dcim_interfaces_partial_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/PatchedWritableInterfaceRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/InterfaceSerializerVersion12'
+ description: ''
+ delete:
+ operationId: dcim_interfaces_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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}/notes/:
+ get:
+ operationId: dcim_interfaces_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this interface.
+ 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:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: dcim_interfaces_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: child_items
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Child items (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: child_items__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Child items (name or ID)
+ explode: true
+ style: form
+ - 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: 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: has_child_items
+ schema:
+ type: boolean
+ description: Has child items
+ - 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
+ - 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
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Parent (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: parent__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Parent (name or ID)
+ explode: true
+ style: form
+ - 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableInventoryItemRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableInventoryItemRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/InventoryItem'
+ description: ''
+ patch:
+ operationId: dcim_inventory_items_bulk_partial_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableInventoryItemRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/InventoryItem'
+ description: ''
+ delete:
+ operationId: dcim_inventory_items_bulk_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /dcim/inventory-items/{id}/:
+ get:
+ operationId: dcim_inventory_items_retrieve
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/WritableInventoryItemRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/PatchedWritableInventoryItemRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/InventoryItem'
+ description: ''
+ delete:
+ operationId: dcim_inventory_items_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/inventory-items/{id}/notes/:
+ get:
+ operationId: dcim_inventory_items_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this inventory item.
+ 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:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: dcim_inventory_items_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /dcim/location-types/:
+ get:
+ operationId: dcim_location_types_list
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: 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
+ - in: query
+ name: nestable
+ 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: parent
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Parent location type (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: parent__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Parent location type (slug or 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/PaginatedLocationTypeList'
+ description: ''
+ post:
+ operationId: dcim_location_types_create
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableLocationTypeRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/LocationType'
+ description: ''
+ put:
+ operationId: dcim_location_types_bulk_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableLocationTypeRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/LocationType'
+ description: ''
+ patch:
+ operationId: dcim_location_types_bulk_partial_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableLocationTypeRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/LocationType'
+ description: ''
+ delete:
+ operationId: dcim_location_types_bulk_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /dcim/location-types/{id}/:
+ get:
+ operationId: dcim_location_types_retrieve
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this location type.
+ required: true
+ tags:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/LocationType'
+ description: ''
+ put:
+ operationId: dcim_location_types_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this location type.
+ required: true
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableLocationTypeRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/LocationType'
+ description: ''
+ patch:
+ operationId: dcim_location_types_partial_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this location type.
+ required: true
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PatchedWritableLocationTypeRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/LocationType'
+ description: ''
+ delete:
+ operationId: dcim_location_types_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this location type.
+ required: true
+ tags:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ /dcim/location-types/{id}/notes/:
+ get:
+ operationId: dcim_location_types_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this location type.
+ 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:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: dcim_location_types_notes_create
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this location type.
+ required: true
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /dcim/locations/:
+ get:
+ operationId: dcim_locations_list
+ description: Mixin to set `metadata_class` to implement `status` field in model
+ viewset metadata.
+ parameters:
+ - in: query
+ name: base_site
+ schema:
+ type: array
+ items:
+ type: string
+ description: Base location's site (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: child_location_type
+ schema:
+ type: array
+ items:
+ type: string
+ description: Child location type (slug or ID)
+ explode: true
+ style: form
+ - 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: location_type
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Location type (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: location_type__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Location type (slug or 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
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Parent location (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: parent__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Parent location (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: q
+ schema:
+ type: string
+ description: Search
+ - in: query
+ name: site
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Site (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: site__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Site (slug or 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: subtree
+ schema:
+ type: array
+ items:
+ type: string
+ description: Location(s) and descendants thereof (slug or 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
+ format: uuid
+ description: Tenant (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: tenant__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Tenant (slug or ID)
+ 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) (deprecated, use "tenant" filter instead)
+ explode: true
+ style: form
+ - in: query
+ name: tenant_id__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ nullable: true
+ description: Tenant (ID) (deprecated, use "tenant" filter instead)
+ explode: true
+ style: form
+ tags:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedLocationList'
+ description: ''
+ post:
+ operationId: dcim_locations_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/WritableLocationRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Location'
+ description: ''
+ put:
+ operationId: dcim_locations_bulk_update
+ description: Mixin to set `metadata_class` to implement `status` field in model
+ viewset metadata.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableLocationRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/Location'
+ description: ''
+ patch:
+ operationId: dcim_locations_bulk_partial_update
+ description: Mixin to set `metadata_class` to implement `status` field in model
+ viewset metadata.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableLocationRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/Location'
+ description: ''
+ delete:
+ operationId: dcim_locations_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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /dcim/locations/{id}/:
+ get:
+ operationId: dcim_locations_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 location.
+ required: true
+ tags:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Location'
+ description: ''
+ put:
+ operationId: dcim_locations_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 location.
+ required: true
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableLocationRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Location'
+ description: ''
+ patch:
+ operationId: dcim_locations_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 location.
+ required: true
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PatchedWritableLocationRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Location'
+ description: ''
+ delete:
+ operationId: dcim_locations_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 location.
+ required: true
+ tags:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ /dcim/locations/{id}/notes/:
+ get:
+ operationId: dcim_locations_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this location.
+ 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:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: dcim_locations_notes_create
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this location.
+ required: true
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /dcim/manufacturers/:
+ get:
+ operationId: dcim_manufacturers_list
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: device_types
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Device types (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: device_types__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Device types (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: has_device_types
+ schema:
+ type: boolean
+ description: Has device types
+ - in: query
+ name: has_inventory_items
+ schema:
+ type: boolean
+ description: Has inventory items
+ - in: query
+ name: has_platforms
+ schema:
+ type: boolean
+ description: Has platforms
+ - 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: inventory_items
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Inventory items (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: inventory_items__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Inventory items (name or 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: 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: platforms
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Platforms (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: platforms__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Platforms (slug or 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/PaginatedManufacturerList'
+ description: ''
+ post:
+ operationId: dcim_manufacturers_create
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ManufacturerRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableManufacturerRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/Manufacturer'
+ description: ''
+ patch:
+ operationId: dcim_manufacturers_bulk_partial_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableManufacturerRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/Manufacturer'
+ description: ''
+ delete:
+ operationId: dcim_manufacturers_bulk_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /dcim/manufacturers/{id}/:
+ get:
+ operationId: dcim_manufacturers_retrieve
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/ManufacturerRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/PatchedManufacturerRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Manufacturer'
+ description: ''
+ delete:
+ operationId: dcim_manufacturers_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/manufacturers/{id}/notes/:
+ get:
+ operationId: dcim_manufacturers_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this manufacturer.
+ 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:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: dcim_manufacturers_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /dcim/platforms/:
+ get:
+ operationId: dcim_platforms_list
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: devices
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: devices__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: has_devices
+ schema:
+ type: boolean
+ description: Has devices
+ - in: query
+ name: has_virtual_machines
+ schema:
+ type: boolean
+ description: Has virtual machines
+ - 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_args
+ 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
+ - in: query
+ name: virtual_machines
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: virtual_machines__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritablePlatformRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritablePlatformRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/Platform'
+ description: ''
+ patch:
+ operationId: dcim_platforms_bulk_partial_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritablePlatformRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/Platform'
+ description: ''
+ delete:
+ operationId: dcim_platforms_bulk_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /dcim/platforms/{id}/:
+ get:
+ operationId: dcim_platforms_retrieve
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/WritablePlatformRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/PatchedWritablePlatformRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Platform'
+ description: ''
+ delete:
+ operationId: dcim_platforms_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/platforms/{id}/notes/:
+ get:
+ operationId: dcim_platforms_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this platform.
+ 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:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: dcim_platforms_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /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
+ - 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: 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: available_power
+ schema:
+ type: array
+ items:
+ type: integer
+ explode: true
+ style: form
+ - in: query
+ name: available_power__gt
+ schema:
+ type: array
+ items:
+ type: integer
+ explode: true
+ style: form
+ - in: query
+ name: available_power__gte
+ schema:
+ type: array
+ items:
+ type: integer
+ explode: true
+ style: form
+ - in: query
+ name: available_power__lt
+ schema:
+ type: array
+ items:
+ type: integer
+ explode: true
+ style: form
+ - in: query
+ name: available_power__lte
+ schema:
+ type: array
+ items:
+ type: integer
+ explode: true
+ style: form
+ - in: query
+ name: available_power__n
+ schema:
+ type: array
+ items:
+ type: integer
+ explode: true
+ style: form
+ - in: query
+ name: cable
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Cable
+ explode: true
+ style: form
+ - in: query
+ name: cable__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Cable
+ explode: true
+ style: form
+ - in: query
+ name: cabled
+ schema:
+ type: boolean
+ - in: query
+ name: comments
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__ic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__ie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__iew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__ire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__isw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__n
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__nic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__nie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__niew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__nire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__nre
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__re
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - 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
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Power panel (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: power_panel__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Power panel (name or ID)
+ explode: true
+ style: form
+ - 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
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Rack (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: rack__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Rack (name or 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: 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/WritablePowerFeedRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritablePowerFeedRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritablePowerFeedRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/WritablePowerFeedRequest'
+ 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/PatchedWritablePowerFeedRequest'
+ 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}/notes/:
+ get:
+ operationId: dcim_power_feeds_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this power feed.
+ 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:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: dcim_power_feeds_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ parameters:
+ - in: query
+ name: description
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__ic
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__ie
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__iew
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__ire
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__isw
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__n
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__nic
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__nie
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__niew
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__nire
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__nre
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__re
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: device_type
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Device type (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: device_type__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Device type (slug or ID)
+ 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: 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
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__ic
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__ie
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__iew
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__ire
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__isw
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__nic
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__nie
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__niew
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__nire
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__nre
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__re
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: label
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__ic
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__ie
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__iew
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__ire
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__isw
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__n
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__nic
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__nie
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__niew
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__nire
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__nre
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__re
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ 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
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__ic
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__ie
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__iew
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__ire
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__isw
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__n
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__nic
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__nie
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__niew
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__nire
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__nre
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__re
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ 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: power_port_template
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Power port template (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: power_port_template__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Power port template (name or ID)
+ 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/PaginatedPowerOutletTemplateList'
+ description: ''
+ post:
+ operationId: dcim_power_outlet_templates_create
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritablePowerOutletTemplateRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritablePowerOutletTemplateRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PowerOutletTemplate'
+ description: ''
+ patch:
+ operationId: dcim_power_outlet_templates_bulk_partial_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritablePowerOutletTemplateRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PowerOutletTemplate'
+ description: ''
+ delete:
+ operationId: dcim_power_outlet_templates_bulk_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /dcim/power-outlet-templates/{id}/:
+ get:
+ operationId: dcim_power_outlet_templates_retrieve
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/WritablePowerOutletTemplateRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/PatchedWritablePowerOutletTemplateRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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-outlet-templates/{id}/notes/:
+ get:
+ operationId: dcim_power_outlet_templates_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this power outlet template.
+ 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:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: dcim_power_outlet_templates_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /dcim/power-outlets/:
+ get:
+ operationId: dcim_power_outlets_list
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ parameters:
+ - in: query
+ name: cable
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Cable
+ explode: true
+ style: form
+ - in: query
+ name: cable__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Cable
+ 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: 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
+ - 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
+ - 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: power_port
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Power port
+ explode: true
+ style: form
+ - in: query
+ name: power_port__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Power port
+ 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: 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritablePowerOutletRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritablePowerOutletRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PowerOutlet'
+ description: ''
+ patch:
+ operationId: dcim_power_outlets_bulk_partial_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritablePowerOutletRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PowerOutlet'
+ description: ''
+ delete:
+ operationId: dcim_power_outlets_bulk_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /dcim/power-outlets/{id}/:
+ get:
+ operationId: dcim_power_outlets_retrieve
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/WritablePowerOutletRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/PatchedWritablePowerOutletRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PowerOutlet'
+ description: ''
+ delete:
+ operationId: dcim_power_outlets_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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}/notes/:
+ get:
+ operationId: dcim_power_outlets_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this power outlet.
+ 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:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: dcim_power_outlets_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: has_power_feeds
+ schema:
+ type: boolean
+ description: Has power 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
+ - 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: location
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Location (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: location__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Location (slug or 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: power_feeds
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Power feeds (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: power_feeds__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Power feeds (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: q
+ schema:
+ type: string
+ description: Search
+ - in: query
+ name: rack_group
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Rack group (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: rack_group__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Rack group (slug or ID)
+ 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_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 or ID)
+ explode: true
+ style: form
+ - in: query
+ name: region__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Region (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: region_id
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Region (ID) (deprecated, use "region" filter instead)
+ explode: true
+ style: form
+ - in: query
+ name: region_id__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Region (ID) (deprecated, use "region" filter instead)
+ explode: true
+ style: form
+ - in: query
+ name: site
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Site (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: site__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Site (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: site_id
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Site (ID) (deprecated, use "site" filter instead)
+ explode: true
+ style: form
+ - in: query
+ name: site_id__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Site (ID) (deprecated, use "site" filter instead)
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritablePowerPanelRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritablePowerPanelRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PowerPanel'
+ description: ''
+ patch:
+ operationId: dcim_power_panels_bulk_partial_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritablePowerPanelRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PowerPanel'
+ description: ''
+ delete:
+ operationId: dcim_power_panels_bulk_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /dcim/power-panels/{id}/:
+ get:
+ operationId: dcim_power_panels_retrieve
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/WritablePowerPanelRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/PatchedWritablePowerPanelRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PowerPanel'
+ description: ''
+ delete:
+ operationId: dcim_power_panels_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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-panels/{id}/notes/:
+ get:
+ operationId: dcim_power_panels_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this power panel.
+ 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:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: dcim_power_panels_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /dcim/power-port-templates/:
+ get:
+ operationId: dcim_power_port_templates_list
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: description
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__ic
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__ie
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__iew
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__ire
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__isw
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__n
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__nic
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__nie
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__niew
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__nire
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__nre
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__re
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: device_type
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Device type (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: device_type__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Device type (slug or ID)
+ 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: has_power_outlet_templates
+ schema:
+ type: boolean
+ description: Has power outlet templates
+ - in: query
+ name: id
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__ic
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__ie
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__iew
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__ire
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__isw
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__nic
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__nie
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__niew
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__nire
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__nre
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__re
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: label
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__ic
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__ie
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__iew
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__ire
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__isw
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__n
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__nic
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__nie
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__niew
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__nire
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__nre
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__re
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ 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
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__ic
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__ie
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__iew
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__ire
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__isw
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__n
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__nic
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__nie
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__niew
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__nire
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__nre
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__re
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ 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: power_outlet_templates
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Power outlet templates (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: power_outlet_templates__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Power outlet templates (name or ID)
+ 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/PaginatedPowerPortTemplateList'
+ description: ''
+ post:
+ operationId: dcim_power_port_templates_create
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritablePowerPortTemplateRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritablePowerPortTemplateRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PowerPortTemplate'
+ description: ''
+ patch:
+ operationId: dcim_power_port_templates_bulk_partial_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritablePowerPortTemplateRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PowerPortTemplate'
+ description: ''
+ delete:
+ operationId: dcim_power_port_templates_bulk_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /dcim/power-port-templates/{id}/:
+ get:
+ operationId: dcim_power_port_templates_retrieve
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/WritablePowerPortTemplateRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/PatchedWritablePowerPortTemplateRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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-port-templates/{id}/notes/:
+ get:
+ operationId: dcim_power_port_templates_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this power port template.
+ 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:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: dcim_power_port_templates_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /dcim/power-ports/:
+ get:
+ operationId: dcim_power_ports_list
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: cable
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Cable
+ explode: true
+ style: form
+ - in: query
+ name: cable__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Cable
+ 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: has_power_outlets
+ schema:
+ type: boolean
+ description: Has power outlets
+ - 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
+ - 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: power_outlets
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Power outlets (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: power_outlets__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Power outlets (name or 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 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritablePowerPortRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritablePowerPortRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PowerPort'
+ description: ''
+ patch:
+ operationId: dcim_power_ports_bulk_partial_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritablePowerPortRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PowerPort'
+ description: ''
+ delete:
+ operationId: dcim_power_ports_bulk_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /dcim/power-ports/{id}/:
+ get:
+ operationId: dcim_power_ports_retrieve
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/WritablePowerPortRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/PatchedWritablePowerPortRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PowerPort'
+ description: ''
+ delete:
+ operationId: dcim_power_ports_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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}/notes/:
+ get:
+ operationId: dcim_power_ports_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this power port.
+ 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:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: dcim_power_ports_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ parameters:
+ - in: query
+ name: children
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Children (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: children__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Children (slug or 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: 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: has_children
+ schema:
+ type: boolean
+ description: Has children
+ - in: query
+ name: has_power_panels
+ schema:
+ type: boolean
+ description: Has power panels
+ - in: query
+ name: has_racks
+ schema:
+ type: boolean
+ description: Has racks
+ - 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: location
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Location (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: location__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Location (slug or 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
+ schema:
+ type: array
+ items:
+ type: string
+ description: Parent (slug)
+ explode: true
+ style: form
+ - in: query
+ name: parent__n
+ schema:
+ type: array
+ items:
+ type: string
+ description: Parent (slug)
+ explode: true
+ style: form
+ - in: query
+ name: parent_id
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ nullable: true
+ description: Parent (ID)
+ explode: true
+ style: form
+ - in: query
+ name: parent_id__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ nullable: true
+ description: Parent (ID)
+ explode: true
+ style: form
+ - in: query
+ name: power_panels
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Power panels (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: power_panels__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Power panels (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: q
+ schema:
+ type: string
+ description: Search
+ - in: query
+ name: racks
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: racks__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: region
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Region (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: region__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Region (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: region_id
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Region (ID) (deprecated, use "region" filter instead)
+ explode: true
+ style: form
+ - in: query
+ name: region_id__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Region (ID) (deprecated, use "region" filter instead)
+ explode: true
+ style: form
+ - in: query
+ name: site
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Site (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: site__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Site (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: site_id
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Site (ID) (deprecated, use "site" filter instead)
+ explode: true
+ style: form
+ - in: query
+ name: site_id__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Site (ID) (deprecated, use "site" filter instead)
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableRackGroupRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableRackGroupRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/RackGroup'
+ description: ''
+ patch:
+ operationId: dcim_rack_groups_bulk_partial_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableRackGroupRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/RackGroup'
+ description: ''
+ delete:
+ operationId: dcim_rack_groups_bulk_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /dcim/rack-groups/{id}/:
+ get:
+ operationId: dcim_rack_groups_retrieve
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/WritableRackGroupRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/PatchedWritableRackGroupRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/RackGroup'
+ description: ''
+ delete:
+ operationId: dcim_rack_groups_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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-groups/{id}/notes/:
+ get:
+ operationId: dcim_rack_groups_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this rack group.
+ 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:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: dcim_rack_groups_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /dcim/rack-reservations/:
+ get:
+ operationId: dcim_rack_reservations_list
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: 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
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Rack (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: rack__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Rack (name or 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: 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
+ format: uuid
+ description: Tenant (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: tenant__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Tenant (slug or ID)
+ 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) (deprecated, use "tenant" filter instead)
+ explode: true
+ style: form
+ - in: query
+ name: tenant_id__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ nullable: true
+ description: Tenant (ID) (deprecated, use "tenant" filter instead)
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableRackReservationRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableRackReservationRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/RackReservation'
+ description: ''
+ patch:
+ operationId: dcim_rack_reservations_bulk_partial_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableRackReservationRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/RackReservation'
+ description: ''
+ delete:
+ operationId: dcim_rack_reservations_bulk_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /dcim/rack-reservations/{id}/:
+ get:
+ operationId: dcim_rack_reservations_retrieve
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/WritableRackReservationRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/PatchedWritableRackReservationRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/RackReservation'
+ description: ''
+ delete:
+ operationId: dcim_rack_reservations_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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-reservations/{id}/notes/:
+ get:
+ operationId: dcim_rack_reservations_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this rack reservation.
+ 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:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: dcim_rack_reservations_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /dcim/rack-roles/:
+ get:
+ operationId: dcim_rack_roles_list
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: 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: has_racks
+ schema:
+ type: boolean
+ description: Has racks
+ - 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: racks
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: racks__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ 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/PaginatedRackRoleList'
+ description: ''
+ post:
+ operationId: dcim_rack_roles_create
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RackRoleRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableRackRoleRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/RackRole'
+ description: ''
+ patch:
+ operationId: dcim_rack_roles_bulk_partial_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableRackRoleRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/RackRole'
+ description: ''
+ delete:
+ operationId: dcim_rack_roles_bulk_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /dcim/rack-roles/{id}/:
+ get:
+ operationId: dcim_rack_roles_retrieve
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/RackRoleRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/PatchedRackRoleRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/RackRole'
+ description: ''
+ delete:
+ operationId: dcim_rack_roles_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/rack-roles/{id}/notes/:
+ get:
+ operationId: dcim_rack_roles_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this rack role.
+ 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:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: dcim_rack_roles_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /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: comments
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__ic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__ie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__iew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__ire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__isw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__n
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__nic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__nie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__niew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__nire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__nre
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__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: devices
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: devices__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - 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: has_devices
+ schema:
+ type: boolean
+ description: Has devices
+ - in: query
+ name: has_power_feeds
+ schema:
+ type: boolean
+ description: Has power feeds
+ - in: query
+ name: has_reservations
+ schema:
+ type: boolean
+ description: Has reservations
+ - 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: location
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Location (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: location__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Location (slug or 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: 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: power_feeds
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Power feeds (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: power_feeds__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Power feeds (name or 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 or ID)
+ explode: true
+ style: form
+ - in: query
+ name: region__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Region (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: region_id
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Region (ID) (deprecated, use "region" filter instead)
+ explode: true
+ style: form
+ - in: query
+ name: region_id__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Region (ID) (deprecated, use "region" filter instead)
+ explode: true
+ style: form
+ - in: query
+ name: reservations
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: reservations__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ 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
+ format: uuid
+ description: Site (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: site__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Site (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: site_id
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Site (ID) (deprecated, use "site" filter instead)
+ explode: true
+ style: form
+ - in: query
+ name: site_id__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Site (ID) (deprecated, use "site" filter instead)
+ 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
+ format: uuid
+ description: Tenant (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: tenant__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Tenant (slug or ID)
+ 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) (deprecated, use "tenant" filter instead)
+ explode: true
+ style: form
+ - in: query
+ name: tenant_id__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ nullable: true
+ description: Tenant (ID) (deprecated, use "tenant" filter instead)
+ 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/WritableRackRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableRackRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableRackRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/WritableRackRequest'
+ 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/PatchedWritableRackRequest'
+ 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: comments
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__ic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__ie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__iew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__ire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__isw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__n
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__nic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__nie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__niew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__nire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__nre
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__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: devices
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: devices__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: display_fullname
+ schema:
+ type: boolean
+ default: true
+ - 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: query
+ name: has_devices
+ schema:
+ type: boolean
+ description: Has devices
+ - in: query
+ name: has_power_feeds
+ schema:
+ type: boolean
+ description: Has power feeds
+ - in: query
+ name: has_reservations
+ schema:
+ type: boolean
+ description: Has reservations
+ - 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: location
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Location (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: location__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Location (slug or 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: 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: power_feeds
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Power feeds (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: power_feeds__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Power feeds (name or ID)
+ 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 or ID)
+ explode: true
+ style: form
+ - in: query
+ name: region__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Region (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: region_id
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Region (ID) (deprecated, use "region" filter instead)
+ explode: true
+ style: form
+ - in: query
+ name: region_id__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Region (ID) (deprecated, use "region" filter instead)
+ explode: true
+ style: form
+ - in: query
+ name: render
+ schema:
+ enum:
+ - json
+ - svg
+ type: string
+ default: json
+ minLength: 1
+ - in: query
+ name: reservations
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: reservations__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ 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
+ format: uuid
+ description: Site (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: site__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Site (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: site_id
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Site (ID) (deprecated, use "site" filter instead)
+ explode: true
+ style: form
+ - in: query
+ name: site_id__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Site (ID) (deprecated, use "site" filter instead)
+ 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
+ format: uuid
+ description: Tenant (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: tenant__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Tenant (slug or ID)
+ 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) (deprecated, use "tenant" filter instead)
+ explode: true
+ style: form
+ - in: query
+ name: tenant_id__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ nullable: true
+ description: Tenant (ID) (deprecated, use "tenant" filter instead)
+ 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/racks/{id}/notes/:
+ get:
+ operationId: dcim_racks_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this rack.
+ 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:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: dcim_racks_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /dcim/rear-port-templates/:
+ get:
+ operationId: dcim_rear_port_templates_list
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ parameters:
+ - in: query
+ name: description
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__ic
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__ie
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__iew
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__ire
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__isw
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__n
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__nic
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__nie
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__niew
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__nire
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__nre
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: description__re
+ schema:
+ type: array
+ items:
+ type: string
+ description: Description
+ explode: true
+ style: form
+ - in: query
+ name: device_type
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Device type (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: device_type__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Device type (slug or ID)
+ 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: front_port_templates
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Front port templates
+ explode: true
+ style: form
+ - in: query
+ name: front_port_templates__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Front port templates
+ explode: true
+ style: form
+ - in: query
+ name: has_front_port_templates
+ schema:
+ type: boolean
+ description: Has front port templates
+ - in: query
+ name: id
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__ic
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__ie
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__iew
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__ire
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__isw
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__nic
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__nie
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__niew
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__nire
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__nre
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: id__re
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: ID
+ explode: true
+ style: form
+ - in: query
+ name: label
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__ic
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__ie
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__iew
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__ire
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__isw
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__n
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__nic
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__nie
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__niew
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__nire
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__nre
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ explode: true
+ style: form
+ - in: query
+ name: label__re
+ schema:
+ type: array
+ items:
+ type: string
+ description: Label
+ 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
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__ic
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__ie
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__iew
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__ire
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__isw
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__n
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__nic
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__nie
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__niew
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__nire
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__nre
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ explode: true
+ style: form
+ - in: query
+ name: name__re
+ schema:
+ type: array
+ items:
+ type: string
+ description: Name
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableRearPortTemplateRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableRearPortTemplateRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/RearPortTemplate'
+ description: ''
+ patch:
+ operationId: dcim_rear_port_templates_bulk_partial_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableRearPortTemplateRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/RearPortTemplate'
+ description: ''
+ delete:
+ operationId: dcim_rear_port_templates_bulk_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /dcim/rear-port-templates/{id}/:
+ get:
+ operationId: dcim_rear_port_templates_retrieve
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/WritableRearPortTemplateRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/PatchedWritableRearPortTemplateRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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-port-templates/{id}/notes/:
+ get:
+ operationId: dcim_rear_port_templates_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this rear port template.
+ 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:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: dcim_rear_port_templates_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /dcim/rear-ports/:
+ get:
+ operationId: dcim_rear_ports_list
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ parameters:
+ - in: query
+ name: cable
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Cable
+ explode: true
+ style: form
+ - in: query
+ name: cable__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Cable
+ explode: true
+ style: form
+ - 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: front_ports
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Front ports (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: front_ports__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Front ports (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: has_front_ports
+ schema:
+ type: boolean
+ description: Has front 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: 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
+ - 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableRearPortRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableRearPortRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/RearPort'
+ description: ''
+ patch:
+ operationId: dcim_rear_ports_bulk_partial_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableRearPortRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/RearPort'
+ description: ''
+ delete:
+ operationId: dcim_rear_ports_bulk_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /dcim/rear-ports/{id}/:
+ get:
+ operationId: dcim_rear_ports_retrieve
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/WritableRearPortRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/PatchedWritableRearPortRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/RearPort'
+ description: ''
+ delete:
+ operationId: dcim_rear_ports_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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}/notes/:
+ get:
+ operationId: dcim_rear_ports_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this rear port.
+ 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:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: dcim_rear_ports_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ parameters:
+ - in: query
+ name: children
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Children (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: children__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Children (slug or 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: 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: has_children
+ schema:
+ type: boolean
+ description: Has children
+ - in: query
+ name: has_sites
+ schema:
+ type: boolean
+ description: Has sites
+ - 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: sites
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Sites (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: sites__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Sites (slug or 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/PaginatedRegionList'
+ description: ''
+ post:
+ operationId: dcim_regions_create
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableRegionRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableRegionRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/Region'
+ description: ''
+ patch:
+ operationId: dcim_regions_bulk_partial_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableRegionRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/Region'
+ description: ''
+ delete:
+ operationId: dcim_regions_bulk_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /dcim/regions/{id}/:
+ get:
+ operationId: dcim_regions_retrieve
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/WritableRegionRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/PatchedWritableRegionRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Region'
+ description: ''
+ delete:
+ operationId: dcim_regions_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/regions/{id}/notes/:
+ get:
+ operationId: dcim_regions_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this region.
+ 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:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: dcim_regions_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /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: circuit_terminations
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: circuit_terminations__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: clusters
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: clusters__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: comments
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__ic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__ie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__iew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__ire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__isw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__n
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__nic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__nie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__niew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__nire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__nre
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__re
+ schema:
+ type: array
+ items:
+ type: string
+ 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: 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: devices
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Devices (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: devices__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Devices (name or ID)
+ explode: true
+ style: form
+ - 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: has_circuit_terminations
+ schema:
+ type: boolean
+ description: Has circuit terminations
+ - in: query
+ name: has_clusters
+ schema:
+ type: boolean
+ description: Has clusters
+ - in: query
+ name: has_devices
+ schema:
+ type: boolean
+ description: Has devices
+ - in: query
+ name: has_locations
+ schema:
+ type: boolean
+ description: Has locations
+ - in: query
+ name: has_power_panels
+ schema:
+ type: boolean
+ description: Has power panels
+ - in: query
+ name: has_prefixes
+ schema:
+ type: boolean
+ description: Has prefixes
+ - in: query
+ name: has_rack_groups
+ schema:
+ type: boolean
+ description: Has rack groups
+ - in: query
+ name: has_racks
+ schema:
+ type: boolean
+ description: Has racks
+ - in: query
+ name: has_vlan_groups
+ schema:
+ type: boolean
+ description: Has vlan groups
+ - in: query
+ name: has_vlans
+ schema:
+ type: boolean
+ description: Has vlans
+ - 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: locations
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Locations within this Site (slugs or IDs)
+ explode: true
+ style: form
+ - in: query
+ name: locations__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Locations within this Site (slugs or IDs)
+ explode: true
+ style: form
+ - 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: physical_address
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: physical_address__ic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: physical_address__ie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: physical_address__iew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: physical_address__ire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: physical_address__isw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: physical_address__n
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: physical_address__nic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: physical_address__nie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: physical_address__niew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: physical_address__nire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: physical_address__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: physical_address__nre
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: physical_address__re
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: power_panels
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Power panels (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: power_panels__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Power panels (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: prefixes
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: prefixes__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: q
+ schema:
+ type: string
+ description: Search
+ - in: query
+ name: rack_groups
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Rack groups (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: rack_groups__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Rack groups (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: racks
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: racks__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ 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: shipping_address
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: shipping_address__ic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: shipping_address__ie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: shipping_address__iew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: shipping_address__ire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: shipping_address__isw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: shipping_address__n
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: shipping_address__nic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: shipping_address__nie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: shipping_address__niew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: shipping_address__nire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: shipping_address__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: shipping_address__nre
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: shipping_address__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
+ - 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
+ format: uuid
+ description: Tenant (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: tenant__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Tenant (slug or ID)
+ 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) (deprecated, use "tenant" filter instead)
+ explode: true
+ style: form
+ - in: query
+ name: tenant_id__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ nullable: true
+ description: Tenant (ID) (deprecated, use "tenant" filter instead)
+ explode: true
+ style: form
+ - in: query
+ name: time_zone
+ schema:
+ type: array
+ items:
+ enum:
+ - Africa/Abidjan
+ - Africa/Accra
+ - Africa/Addis_Ababa
+ - Africa/Algiers
+ - Africa/Asmara
+ - Africa/Bamako
+ - Africa/Bangui
+ - Africa/Banjul
+ - Africa/Bissau
+ - Africa/Blantyre
+ - Africa/Brazzaville
+ - Africa/Bujumbura
+ - Africa/Cairo
+ - Africa/Casablanca
+ - Africa/Ceuta
+ - Africa/Conakry
+ - Africa/Dakar
+ - Africa/Dar_es_Salaam
+ - Africa/Djibouti
+ - Africa/Douala
+ - Africa/El_Aaiun
+ - Africa/Freetown
+ - Africa/Gaborone
+ - Africa/Harare
+ - Africa/Johannesburg
+ - Africa/Juba
+ - Africa/Kampala
+ - Africa/Khartoum
+ - Africa/Kigali
+ - Africa/Kinshasa
+ - Africa/Lagos
+ - Africa/Libreville
+ - Africa/Lome
+ - Africa/Luanda
+ - Africa/Lubumbashi
+ - Africa/Lusaka
+ - Africa/Malabo
+ - Africa/Maputo
+ - Africa/Maseru
+ - Africa/Mbabane
+ - Africa/Mogadishu
+ - Africa/Monrovia
+ - Africa/Nairobi
+ - Africa/Ndjamena
+ - Africa/Niamey
+ - Africa/Nouakchott
+ - Africa/Ouagadougou
+ - Africa/Porto-Novo
+ - Africa/Sao_Tome
+ - Africa/Tripoli
+ - Africa/Tunis
+ - Africa/Windhoek
+ - America/Adak
+ - America/Anchorage
+ - America/Anguilla
+ - America/Antigua
+ - America/Araguaina
+ - America/Argentina/Buenos_Aires
+ - America/Argentina/Catamarca
+ - America/Argentina/Cordoba
+ - America/Argentina/Jujuy
+ - America/Argentina/La_Rioja
+ - America/Argentina/Mendoza
+ - America/Argentina/Rio_Gallegos
+ - America/Argentina/Salta
+ - America/Argentina/San_Juan
+ - America/Argentina/San_Luis
+ - America/Argentina/Tucuman
+ - America/Argentina/Ushuaia
+ - America/Aruba
+ - America/Asuncion
+ - America/Atikokan
+ - America/Bahia
+ - America/Bahia_Banderas
+ - America/Barbados
+ - America/Belem
+ - America/Belize
+ - America/Blanc-Sablon
+ - America/Boa_Vista
+ - America/Bogota
+ - America/Boise
+ - America/Cambridge_Bay
+ - America/Campo_Grande
+ - America/Cancun
+ - America/Caracas
+ - America/Cayenne
+ - America/Cayman
+ - America/Chicago
+ - America/Chihuahua
+ - America/Ciudad_Juarez
+ - America/Costa_Rica
+ - America/Creston
+ - America/Cuiaba
+ - America/Curacao
+ - America/Danmarkshavn
+ - America/Dawson
+ - America/Dawson_Creek
+ - America/Denver
+ - America/Detroit
+ - America/Dominica
+ - America/Edmonton
+ - America/Eirunepe
+ - America/El_Salvador
+ - America/Fort_Nelson
+ - America/Fortaleza
+ - America/Glace_Bay
+ - America/Goose_Bay
+ - America/Grand_Turk
+ - America/Grenada
+ - America/Guadeloupe
+ - America/Guatemala
+ - America/Guayaquil
+ - America/Guyana
+ - America/Halifax
+ - America/Havana
+ - America/Hermosillo
+ - America/Indiana/Indianapolis
+ - America/Indiana/Knox
+ - America/Indiana/Marengo
+ - America/Indiana/Petersburg
+ - America/Indiana/Tell_City
+ - America/Indiana/Vevay
+ - America/Indiana/Vincennes
+ - America/Indiana/Winamac
+ - America/Inuvik
+ - America/Iqaluit
+ - America/Jamaica
+ - America/Juneau
+ - America/Kentucky/Louisville
+ - America/Kentucky/Monticello
+ - America/Kralendijk
+ - America/La_Paz
+ - America/Lima
+ - America/Los_Angeles
+ - America/Lower_Princes
+ - America/Maceio
+ - America/Managua
+ - America/Manaus
+ - America/Marigot
+ - America/Martinique
+ - America/Matamoros
+ - America/Mazatlan
+ - America/Menominee
+ - America/Merida
+ - America/Metlakatla
+ - America/Mexico_City
+ - America/Miquelon
+ - America/Moncton
+ - America/Monterrey
+ - America/Montevideo
+ - America/Montserrat
+ - America/Nassau
+ - America/New_York
+ - America/Nome
+ - America/Noronha
+ - America/North_Dakota/Beulah
+ - America/North_Dakota/Center
+ - America/North_Dakota/New_Salem
+ - America/Nuuk
+ - America/Ojinaga
+ - America/Panama
+ - America/Paramaribo
+ - America/Phoenix
+ - America/Port-au-Prince
+ - America/Port_of_Spain
+ - America/Porto_Velho
+ - America/Puerto_Rico
+ - America/Punta_Arenas
+ - America/Rankin_Inlet
+ - America/Recife
+ - America/Regina
+ - America/Resolute
+ - America/Rio_Branco
+ - America/Santarem
+ - America/Santiago
+ - America/Santo_Domingo
+ - America/Sao_Paulo
+ - America/Scoresbysund
+ - America/Sitka
+ - America/St_Barthelemy
+ - America/St_Johns
+ - America/St_Kitts
+ - America/St_Lucia
+ - America/St_Thomas
+ - America/St_Vincent
+ - America/Swift_Current
+ - America/Tegucigalpa
+ - America/Thule
+ - America/Tijuana
+ - America/Toronto
+ - America/Tortola
+ - America/Vancouver
+ - America/Whitehorse
+ - America/Winnipeg
+ - America/Yakutat
+ - America/Yellowknife
+ - Antarctica/Casey
+ - Antarctica/Davis
+ - Antarctica/DumontDUrville
+ - Antarctica/Macquarie
+ - Antarctica/Mawson
+ - Antarctica/McMurdo
+ - Antarctica/Palmer
+ - Antarctica/Rothera
+ - Antarctica/Syowa
+ - Antarctica/Troll
+ - Antarctica/Vostok
+ - Arctic/Longyearbyen
+ - Asia/Aden
+ - Asia/Almaty
+ - Asia/Amman
+ - Asia/Anadyr
+ - Asia/Aqtau
+ - Asia/Aqtobe
+ - Asia/Ashgabat
+ - Asia/Atyrau
+ - Asia/Baghdad
+ - Asia/Bahrain
+ - Asia/Baku
+ - Asia/Bangkok
+ - Asia/Barnaul
+ - Asia/Beirut
+ - Asia/Bishkek
+ - Asia/Brunei
+ - Asia/Chita
+ - Asia/Choibalsan
+ - Asia/Colombo
+ - Asia/Damascus
+ - Asia/Dhaka
+ - Asia/Dili
+ - Asia/Dubai
+ - Asia/Dushanbe
+ - Asia/Famagusta
+ - Asia/Gaza
+ - Asia/Hebron
+ - Asia/Ho_Chi_Minh
+ - Asia/Hong_Kong
+ - Asia/Hovd
+ - Asia/Irkutsk
+ - Asia/Jakarta
+ - Asia/Jayapura
+ - Asia/Jerusalem
+ - Asia/Kabul
+ - Asia/Kamchatka
+ - Asia/Karachi
+ - Asia/Kathmandu
+ - Asia/Khandyga
+ - Asia/Kolkata
+ - Asia/Krasnoyarsk
+ - Asia/Kuala_Lumpur
+ - Asia/Kuching
+ - Asia/Kuwait
+ - Asia/Macau
+ - Asia/Magadan
+ - Asia/Makassar
+ - Asia/Manila
+ - Asia/Muscat
+ - Asia/Nicosia
+ - Asia/Novokuznetsk
+ - Asia/Novosibirsk
+ - Asia/Omsk
+ - Asia/Oral
+ - Asia/Phnom_Penh
+ - Asia/Pontianak
+ - Asia/Pyongyang
+ - Asia/Qatar
+ - Asia/Qostanay
+ - Asia/Qyzylorda
+ - Asia/Riyadh
+ - Asia/Sakhalin
+ - Asia/Samarkand
+ - Asia/Seoul
+ - Asia/Shanghai
+ - Asia/Singapore
+ - Asia/Srednekolymsk
+ - Asia/Taipei
+ - Asia/Tashkent
+ - Asia/Tbilisi
+ - Asia/Tehran
+ - Asia/Thimphu
+ - Asia/Tokyo
+ - Asia/Tomsk
+ - Asia/Ulaanbaatar
+ - Asia/Urumqi
+ - Asia/Ust-Nera
+ - Asia/Vientiane
+ - Asia/Vladivostok
+ - Asia/Yakutsk
+ - Asia/Yangon
+ - Asia/Yekaterinburg
+ - Asia/Yerevan
+ - Atlantic/Azores
+ - Atlantic/Bermuda
+ - Atlantic/Canary
+ - Atlantic/Cape_Verde
+ - Atlantic/Faroe
+ - Atlantic/Madeira
+ - Atlantic/Reykjavik
+ - Atlantic/South_Georgia
+ - Atlantic/St_Helena
+ - Atlantic/Stanley
+ - Australia/Adelaide
+ - Australia/Brisbane
+ - Australia/Broken_Hill
+ - Australia/Darwin
+ - Australia/Eucla
+ - Australia/Hobart
+ - Australia/Lindeman
+ - Australia/Lord_Howe
+ - Australia/Melbourne
+ - Australia/Perth
+ - Australia/Sydney
+ - Canada/Atlantic
+ - Canada/Central
+ - Canada/Eastern
+ - Canada/Mountain
+ - Canada/Newfoundland
+ - Canada/Pacific
+ - Europe/Amsterdam
+ - Europe/Andorra
+ - Europe/Astrakhan
+ - Europe/Athens
+ - Europe/Belgrade
+ - Europe/Berlin
+ - Europe/Bratislava
+ - Europe/Brussels
+ - Europe/Bucharest
+ - Europe/Budapest
+ - Europe/Busingen
+ - Europe/Chisinau
+ - Europe/Copenhagen
+ - Europe/Dublin
+ - Europe/Gibraltar
+ - Europe/Guernsey
+ - Europe/Helsinki
+ - Europe/Isle_of_Man
+ - Europe/Istanbul
+ - Europe/Jersey
+ - Europe/Kaliningrad
+ - Europe/Kirov
+ - Europe/Kyiv
+ - Europe/Lisbon
+ - Europe/Ljubljana
+ - Europe/London
+ - Europe/Luxembourg
+ - Europe/Madrid
+ - Europe/Malta
+ - Europe/Mariehamn
+ - Europe/Minsk
+ - Europe/Monaco
+ - Europe/Moscow
+ - Europe/Oslo
+ - Europe/Paris
+ - Europe/Podgorica
+ - Europe/Prague
+ - Europe/Riga
+ - Europe/Rome
+ - Europe/Samara
+ - Europe/San_Marino
+ - Europe/Sarajevo
+ - Europe/Saratov
+ - Europe/Simferopol
+ - Europe/Skopje
+ - Europe/Sofia
+ - Europe/Stockholm
+ - Europe/Tallinn
+ - Europe/Tirane
+ - Europe/Ulyanovsk
+ - Europe/Vaduz
+ - Europe/Vatican
+ - Europe/Vienna
+ - Europe/Vilnius
+ - Europe/Volgograd
+ - Europe/Warsaw
+ - Europe/Zagreb
+ - Europe/Zurich
+ - GMT
+ - Indian/Antananarivo
+ - Indian/Chagos
+ - Indian/Christmas
+ - Indian/Cocos
+ - Indian/Comoro
+ - Indian/Kerguelen
+ - Indian/Mahe
+ - Indian/Maldives
+ - Indian/Mauritius
+ - Indian/Mayotte
+ - Indian/Reunion
+ - Pacific/Apia
+ - Pacific/Auckland
+ - Pacific/Bougainville
+ - Pacific/Chatham
+ - Pacific/Chuuk
+ - Pacific/Easter
+ - Pacific/Efate
+ - Pacific/Fakaofo
+ - Pacific/Fiji
+ - Pacific/Funafuti
+ - Pacific/Galapagos
+ - Pacific/Gambier
+ - Pacific/Guadalcanal
+ - Pacific/Guam
+ - Pacific/Honolulu
+ - Pacific/Kanton
+ - Pacific/Kiritimati
+ - Pacific/Kosrae
+ - Pacific/Kwajalein
+ - Pacific/Majuro
+ - Pacific/Marquesas
+ - Pacific/Midway
+ - Pacific/Nauru
+ - Pacific/Niue
+ - Pacific/Norfolk
+ - Pacific/Noumea
+ - Pacific/Pago_Pago
+ - Pacific/Palau
+ - Pacific/Pitcairn
+ - Pacific/Pohnpei
+ - Pacific/Port_Moresby
+ - Pacific/Rarotonga
+ - Pacific/Saipan
+ - Pacific/Tahiti
+ - Pacific/Tarawa
+ - Pacific/Tongatapu
+ - Pacific/Wake
+ - Pacific/Wallis
+ - US/Alaska
+ - US/Arizona
+ - US/Central
+ - US/Eastern
+ - US/Hawaii
+ - US/Mountain
+ - US/Pacific
+ - UTC
+ description: Time zone
+ explode: true
+ style: form
+ - in: query
+ name: time_zone__n
+ schema:
+ type: array
+ items:
+ enum:
+ - Africa/Abidjan
+ - Africa/Accra
+ - Africa/Addis_Ababa
+ - Africa/Algiers
+ - Africa/Asmara
+ - Africa/Bamako
+ - Africa/Bangui
+ - Africa/Banjul
+ - Africa/Bissau
+ - Africa/Blantyre
+ - Africa/Brazzaville
+ - Africa/Bujumbura
+ - Africa/Cairo
+ - Africa/Casablanca
+ - Africa/Ceuta
+ - Africa/Conakry
+ - Africa/Dakar
+ - Africa/Dar_es_Salaam
+ - Africa/Djibouti
+ - Africa/Douala
+ - Africa/El_Aaiun
+ - Africa/Freetown
+ - Africa/Gaborone
+ - Africa/Harare
+ - Africa/Johannesburg
+ - Africa/Juba
+ - Africa/Kampala
+ - Africa/Khartoum
+ - Africa/Kigali
+ - Africa/Kinshasa
+ - Africa/Lagos
+ - Africa/Libreville
+ - Africa/Lome
+ - Africa/Luanda
+ - Africa/Lubumbashi
+ - Africa/Lusaka
+ - Africa/Malabo
+ - Africa/Maputo
+ - Africa/Maseru
+ - Africa/Mbabane
+ - Africa/Mogadishu
+ - Africa/Monrovia
+ - Africa/Nairobi
+ - Africa/Ndjamena
+ - Africa/Niamey
+ - Africa/Nouakchott
+ - Africa/Ouagadougou
+ - Africa/Porto-Novo
+ - Africa/Sao_Tome
+ - Africa/Tripoli
+ - Africa/Tunis
+ - Africa/Windhoek
+ - America/Adak
+ - America/Anchorage
+ - America/Anguilla
+ - America/Antigua
+ - America/Araguaina
+ - America/Argentina/Buenos_Aires
+ - America/Argentina/Catamarca
+ - America/Argentina/Cordoba
+ - America/Argentina/Jujuy
+ - America/Argentina/La_Rioja
+ - America/Argentina/Mendoza
+ - America/Argentina/Rio_Gallegos
+ - America/Argentina/Salta
+ - America/Argentina/San_Juan
+ - America/Argentina/San_Luis
+ - America/Argentina/Tucuman
+ - America/Argentina/Ushuaia
+ - America/Aruba
+ - America/Asuncion
+ - America/Atikokan
+ - America/Bahia
+ - America/Bahia_Banderas
+ - America/Barbados
+ - America/Belem
+ - America/Belize
+ - America/Blanc-Sablon
+ - America/Boa_Vista
+ - America/Bogota
+ - America/Boise
+ - America/Cambridge_Bay
+ - America/Campo_Grande
+ - America/Cancun
+ - America/Caracas
+ - America/Cayenne
+ - America/Cayman
+ - America/Chicago
+ - America/Chihuahua
+ - America/Ciudad_Juarez
+ - America/Costa_Rica
+ - America/Creston
+ - America/Cuiaba
+ - America/Curacao
+ - America/Danmarkshavn
+ - America/Dawson
+ - America/Dawson_Creek
+ - America/Denver
+ - America/Detroit
+ - America/Dominica
+ - America/Edmonton
+ - America/Eirunepe
+ - America/El_Salvador
+ - America/Fort_Nelson
+ - America/Fortaleza
+ - America/Glace_Bay
+ - America/Goose_Bay
+ - America/Grand_Turk
+ - America/Grenada
+ - America/Guadeloupe
+ - America/Guatemala
+ - America/Guayaquil
+ - America/Guyana
+ - America/Halifax
+ - America/Havana
+ - America/Hermosillo
+ - America/Indiana/Indianapolis
+ - America/Indiana/Knox
+ - America/Indiana/Marengo
+ - America/Indiana/Petersburg
+ - America/Indiana/Tell_City
+ - America/Indiana/Vevay
+ - America/Indiana/Vincennes
+ - America/Indiana/Winamac
+ - America/Inuvik
+ - America/Iqaluit
+ - America/Jamaica
+ - America/Juneau
+ - America/Kentucky/Louisville
+ - America/Kentucky/Monticello
+ - America/Kralendijk
+ - America/La_Paz
+ - America/Lima
+ - America/Los_Angeles
+ - America/Lower_Princes
+ - America/Maceio
+ - America/Managua
+ - America/Manaus
+ - America/Marigot
+ - America/Martinique
+ - America/Matamoros
+ - America/Mazatlan
+ - America/Menominee
+ - America/Merida
+ - America/Metlakatla
+ - America/Mexico_City
+ - America/Miquelon
+ - America/Moncton
+ - America/Monterrey
+ - America/Montevideo
+ - America/Montserrat
+ - America/Nassau
+ - America/New_York
+ - America/Nome
+ - America/Noronha
+ - America/North_Dakota/Beulah
+ - America/North_Dakota/Center
+ - America/North_Dakota/New_Salem
+ - America/Nuuk
+ - America/Ojinaga
+ - America/Panama
+ - America/Paramaribo
+ - America/Phoenix
+ - America/Port-au-Prince
+ - America/Port_of_Spain
+ - America/Porto_Velho
+ - America/Puerto_Rico
+ - America/Punta_Arenas
+ - America/Rankin_Inlet
+ - America/Recife
+ - America/Regina
+ - America/Resolute
+ - America/Rio_Branco
+ - America/Santarem
+ - America/Santiago
+ - America/Santo_Domingo
+ - America/Sao_Paulo
+ - America/Scoresbysund
+ - America/Sitka
+ - America/St_Barthelemy
+ - America/St_Johns
+ - America/St_Kitts
+ - America/St_Lucia
+ - America/St_Thomas
+ - America/St_Vincent
+ - America/Swift_Current
+ - America/Tegucigalpa
+ - America/Thule
+ - America/Tijuana
+ - America/Toronto
+ - America/Tortola
+ - America/Vancouver
+ - America/Whitehorse
+ - America/Winnipeg
+ - America/Yakutat
+ - America/Yellowknife
+ - Antarctica/Casey
+ - Antarctica/Davis
+ - Antarctica/DumontDUrville
+ - Antarctica/Macquarie
+ - Antarctica/Mawson
+ - Antarctica/McMurdo
+ - Antarctica/Palmer
+ - Antarctica/Rothera
+ - Antarctica/Syowa
+ - Antarctica/Troll
+ - Antarctica/Vostok
+ - Arctic/Longyearbyen
+ - Asia/Aden
+ - Asia/Almaty
+ - Asia/Amman
+ - Asia/Anadyr
+ - Asia/Aqtau
+ - Asia/Aqtobe
+ - Asia/Ashgabat
+ - Asia/Atyrau
+ - Asia/Baghdad
+ - Asia/Bahrain
+ - Asia/Baku
+ - Asia/Bangkok
+ - Asia/Barnaul
+ - Asia/Beirut
+ - Asia/Bishkek
+ - Asia/Brunei
+ - Asia/Chita
+ - Asia/Choibalsan
+ - Asia/Colombo
+ - Asia/Damascus
+ - Asia/Dhaka
+ - Asia/Dili
+ - Asia/Dubai
+ - Asia/Dushanbe
+ - Asia/Famagusta
+ - Asia/Gaza
+ - Asia/Hebron
+ - Asia/Ho_Chi_Minh
+ - Asia/Hong_Kong
+ - Asia/Hovd
+ - Asia/Irkutsk
+ - Asia/Jakarta
+ - Asia/Jayapura
+ - Asia/Jerusalem
+ - Asia/Kabul
+ - Asia/Kamchatka
+ - Asia/Karachi
+ - Asia/Kathmandu
+ - Asia/Khandyga
+ - Asia/Kolkata
+ - Asia/Krasnoyarsk
+ - Asia/Kuala_Lumpur
+ - Asia/Kuching
+ - Asia/Kuwait
+ - Asia/Macau
+ - Asia/Magadan
+ - Asia/Makassar
+ - Asia/Manila
+ - Asia/Muscat
+ - Asia/Nicosia
+ - Asia/Novokuznetsk
+ - Asia/Novosibirsk
+ - Asia/Omsk
+ - Asia/Oral
+ - Asia/Phnom_Penh
+ - Asia/Pontianak
+ - Asia/Pyongyang
+ - Asia/Qatar
+ - Asia/Qostanay
+ - Asia/Qyzylorda
+ - Asia/Riyadh
+ - Asia/Sakhalin
+ - Asia/Samarkand
+ - Asia/Seoul
+ - Asia/Shanghai
+ - Asia/Singapore
+ - Asia/Srednekolymsk
+ - Asia/Taipei
+ - Asia/Tashkent
+ - Asia/Tbilisi
+ - Asia/Tehran
+ - Asia/Thimphu
+ - Asia/Tokyo
+ - Asia/Tomsk
+ - Asia/Ulaanbaatar
+ - Asia/Urumqi
+ - Asia/Ust-Nera
+ - Asia/Vientiane
+ - Asia/Vladivostok
+ - Asia/Yakutsk
+ - Asia/Yangon
+ - Asia/Yekaterinburg
+ - Asia/Yerevan
+ - Atlantic/Azores
+ - Atlantic/Bermuda
+ - Atlantic/Canary
+ - Atlantic/Cape_Verde
+ - Atlantic/Faroe
+ - Atlantic/Madeira
+ - Atlantic/Reykjavik
+ - Atlantic/South_Georgia
+ - Atlantic/St_Helena
+ - Atlantic/Stanley
+ - Australia/Adelaide
+ - Australia/Brisbane
+ - Australia/Broken_Hill
+ - Australia/Darwin
+ - Australia/Eucla
+ - Australia/Hobart
+ - Australia/Lindeman
+ - Australia/Lord_Howe
+ - Australia/Melbourne
+ - Australia/Perth
+ - Australia/Sydney
+ - Canada/Atlantic
+ - Canada/Central
+ - Canada/Eastern
+ - Canada/Mountain
+ - Canada/Newfoundland
+ - Canada/Pacific
+ - Europe/Amsterdam
+ - Europe/Andorra
+ - Europe/Astrakhan
+ - Europe/Athens
+ - Europe/Belgrade
+ - Europe/Berlin
+ - Europe/Bratislava
+ - Europe/Brussels
+ - Europe/Bucharest
+ - Europe/Budapest
+ - Europe/Busingen
+ - Europe/Chisinau
+ - Europe/Copenhagen
+ - Europe/Dublin
+ - Europe/Gibraltar
+ - Europe/Guernsey
+ - Europe/Helsinki
+ - Europe/Isle_of_Man
+ - Europe/Istanbul
+ - Europe/Jersey
+ - Europe/Kaliningrad
+ - Europe/Kirov
+ - Europe/Kyiv
+ - Europe/Lisbon
+ - Europe/Ljubljana
+ - Europe/London
+ - Europe/Luxembourg
+ - Europe/Madrid
+ - Europe/Malta
+ - Europe/Mariehamn
+ - Europe/Minsk
+ - Europe/Monaco
+ - Europe/Moscow
+ - Europe/Oslo
+ - Europe/Paris
+ - Europe/Podgorica
+ - Europe/Prague
+ - Europe/Riga
+ - Europe/Rome
+ - Europe/Samara
+ - Europe/San_Marino
+ - Europe/Sarajevo
+ - Europe/Saratov
+ - Europe/Simferopol
+ - Europe/Skopje
+ - Europe/Sofia
+ - Europe/Stockholm
+ - Europe/Tallinn
+ - Europe/Tirane
+ - Europe/Ulyanovsk
+ - Europe/Vaduz
+ - Europe/Vatican
+ - Europe/Vienna
+ - Europe/Vilnius
+ - Europe/Volgograd
+ - Europe/Warsaw
+ - Europe/Zagreb
+ - Europe/Zurich
+ - GMT
+ - Indian/Antananarivo
+ - Indian/Chagos
+ - Indian/Christmas
+ - Indian/Cocos
+ - Indian/Comoro
+ - Indian/Kerguelen
+ - Indian/Mahe
+ - Indian/Maldives
+ - Indian/Mauritius
+ - Indian/Mayotte
+ - Indian/Reunion
+ - Pacific/Apia
+ - Pacific/Auckland
+ - Pacific/Bougainville
+ - Pacific/Chatham
+ - Pacific/Chuuk
+ - Pacific/Easter
+ - Pacific/Efate
+ - Pacific/Fakaofo
+ - Pacific/Fiji
+ - Pacific/Funafuti
+ - Pacific/Galapagos
+ - Pacific/Gambier
+ - Pacific/Guadalcanal
+ - Pacific/Guam
+ - Pacific/Honolulu
+ - Pacific/Kanton
+ - Pacific/Kiritimati
+ - Pacific/Kosrae
+ - Pacific/Kwajalein
+ - Pacific/Majuro
+ - Pacific/Marquesas
+ - Pacific/Midway
+ - Pacific/Nauru
+ - Pacific/Niue
+ - Pacific/Norfolk
+ - Pacific/Noumea
+ - Pacific/Pago_Pago
+ - Pacific/Palau
+ - Pacific/Pitcairn
+ - Pacific/Pohnpei
+ - Pacific/Port_Moresby
+ - Pacific/Rarotonga
+ - Pacific/Saipan
+ - Pacific/Tahiti
+ - Pacific/Tarawa
+ - Pacific/Tongatapu
+ - Pacific/Wake
+ - Pacific/Wallis
+ - US/Alaska
+ - US/Arizona
+ - US/Central
+ - US/Eastern
+ - US/Hawaii
+ - US/Mountain
+ - US/Pacific
+ - UTC
+ description: Time zone
+ explode: true
+ style: form
+ - in: query
+ name: vlan_groups
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Vlan groups (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: vlan_groups__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Vlan groups (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: vlans
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: vlans__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ 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/WritableSiteRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableSiteRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableSiteRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/WritableSiteRequest'
+ 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/PatchedWritableSiteRequest'
+ 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/sites/{id}/notes/:
+ get:
+ operationId: dcim_sites_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this site.
+ 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:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: dcim_sites_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /dcim/virtual-chassis/:
+ get:
+ operationId: dcim_virtual_chassis_list
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: has_members
+ schema:
+ type: boolean
+ description: Has device members
+ - 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: members
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Device members (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: members__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Device members (name or 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableVirtualChassisRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableVirtualChassisRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/VirtualChassis'
+ description: ''
+ patch:
+ operationId: dcim_virtual_chassis_bulk_partial_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableVirtualChassisRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/VirtualChassis'
+ description: ''
+ delete:
+ operationId: dcim_virtual_chassis_bulk_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /dcim/virtual-chassis/{id}/:
+ get:
+ operationId: dcim_virtual_chassis_retrieve
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/WritableVirtualChassisRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/PatchedWritableVirtualChassisRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/VirtualChassis'
+ description: ''
+ delete:
+ operationId: dcim_virtual_chassis_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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
+ /dcim/virtual-chassis/{id}/notes/:
+ get:
+ operationId: dcim_virtual_chassis_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this virtual chassis.
+ 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:
+ - dcim
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: dcim_virtual_chassis_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /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
+ - 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: 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/ComputedFieldRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableComputedFieldRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableComputedFieldRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/ComputedFieldRequest'
+ 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/PatchedComputedFieldRequest'
+ 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/computed-fields/{id}/notes/:
+ get:
+ operationId: extras_computed_fields_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this computed field.
+ 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/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: extras_computed_fields_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /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/ConfigContextSchemaRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableConfigContextSchemaRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableConfigContextSchemaRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/ConfigContextSchemaRequest'
+ 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/PatchedConfigContextSchemaRequest'
+ 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-context-schemas/{id}/notes/:
+ get:
+ operationId: extras_config_context_schemas_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this config context schema.
+ 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/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: extras_config_context_schemas_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /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_redundancy_group
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Device Redundancy Group (slug or PK)
+ explode: true
+ style: form
+ - in: query
+ name: device_redundancy_group__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Device Redundancy Group (slug or PK)
+ 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: location
+ schema:
+ type: array
+ items:
+ type: string
+ description: Location (slug)
+ explode: true
+ style: form
+ - in: query
+ name: location__n
+ schema:
+ type: array
+ items:
+ type: string
+ description: Location (slug)
+ explode: true
+ style: form
+ - in: query
+ name: location_id
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Location (ID)
+ explode: true
+ style: form
+ - in: query
+ name: location_id__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Location (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: 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: schema
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Schema (slug or PK)
+ explode: true
+ style: form
+ - in: query
+ name: schema__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Schema (slug or PK)
+ 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/WritableConfigContextRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableConfigContextRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableConfigContextRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/WritableConfigContextRequest'
+ 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/PatchedWritableConfigContextRequest'
+ 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/config-contexts/{id}/notes/:
+ get:
+ operationId: extras_config_contexts_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this config context.
+ 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/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: extras_config_contexts_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /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: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: app_label__ic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: app_label__ie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: app_label__iew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: app_label__ire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: app_label__isw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: app_label__n
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: app_label__nic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: app_label__nie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: app_label__niew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: app_label__nire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: app_label__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: app_label__nre
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: app_label__re
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - 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: 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: q
+ schema:
+ type: string
+ description: Search
+ 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
+ description: Field (name)
+ explode: true
+ style: form
+ - in: query
+ name: field__n
+ schema:
+ type: array
+ items:
+ type: string
+ 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/WritableCustomFieldChoiceRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableCustomFieldChoiceRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableCustomFieldChoiceRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/WritableCustomFieldChoiceRequest'
+ 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/PatchedWritableCustomFieldChoiceRequest'
+ 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/PaginatedCustomFieldSerializerVersion12List'
+ 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/CustomFieldSerializerVersion12Request'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/CustomFieldSerializerVersion12'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/CustomFieldSerializerVersion12Request'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/CustomFieldSerializerVersion12'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/CustomFieldSerializerVersion12Request'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/CustomFieldSerializerVersion12'
+ 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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/CustomFieldSerializerVersion12'
+ 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/CustomFieldSerializerVersion12Request'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/CustomFieldSerializerVersion12'
+ 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/PatchedCustomFieldSerializerVersion12Request'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/CustomFieldSerializerVersion12'
+ 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-fields/{id}/notes/:
+ get:
+ operationId: extras_custom_fields_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this custom field.
+ 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/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: extras_custom_fields_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /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
+ - 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: 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/CustomLinkRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableCustomLinkRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableCustomLinkRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/CustomLinkRequest'
+ 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/PatchedCustomLinkRequest'
+ 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/custom-links/{id}/notes/:
+ get:
+ operationId: extras_custom_links_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this custom link.
+ 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/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: extras_custom_links_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /extras/dynamic-group-memberships/:
+ get:
+ operationId: extras_dynamic_group_memberships_list
+ description: Manage Dynamic Group Memberships 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: group
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Group (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: group__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Group (slug or 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: operator
+ schema:
+ type: string
+ enum:
+ - difference
+ - intersection
+ - union
+ - in: query
+ name: operator__n
+ schema:
+ type: string
+ enum:
+ - difference
+ - intersection
+ - union
+ - in: query
+ name: parent_group
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Parent Group (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: parent_group__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Parent Group (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: q
+ schema:
+ type: string
+ description: Search
+ - 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/PaginatedDynamicGroupMembershipList'
+ description: ''
+ post:
+ operationId: extras_dynamic_group_memberships_create
+ description: Manage Dynamic Group Memberships through DELETE, GET, POST, PUT,
+ and PATCH requests.
+ tags:
+ - extras
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableDynamicGroupMembershipRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/DynamicGroupMembership'
+ description: ''
+ put:
+ operationId: extras_dynamic_group_memberships_bulk_update
+ description: Manage Dynamic Group Memberships through DELETE, GET, POST, PUT,
+ and PATCH requests.
+ tags:
+ - extras
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableDynamicGroupMembershipRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/DynamicGroupMembership'
+ description: ''
+ patch:
+ operationId: extras_dynamic_group_memberships_bulk_partial_update
+ description: Manage Dynamic Group Memberships through DELETE, GET, POST, PUT,
+ and PATCH requests.
+ tags:
+ - extras
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableDynamicGroupMembershipRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/DynamicGroupMembership'
+ description: ''
+ delete:
+ operationId: extras_dynamic_group_memberships_bulk_destroy
+ description: Manage Dynamic Group Memberships through DELETE, GET, POST, PUT,
+ and PATCH requests.
+ tags:
+ - extras
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /extras/dynamic-group-memberships/{id}/:
+ get:
+ operationId: extras_dynamic_group_memberships_retrieve
+ description: Manage Dynamic Group Memberships 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 membership.
+ required: true
+ tags:
+ - extras
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/DynamicGroupMembership'
+ description: ''
+ put:
+ operationId: extras_dynamic_group_memberships_update
+ description: Manage Dynamic Group Memberships 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 membership.
+ required: true
+ tags:
+ - extras
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableDynamicGroupMembershipRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/DynamicGroupMembership'
+ description: ''
+ patch:
+ operationId: extras_dynamic_group_memberships_partial_update
+ description: Manage Dynamic Group Memberships 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 membership.
+ required: true
+ tags:
+ - extras
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PatchedWritableDynamicGroupMembershipRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/DynamicGroupMembership'
+ description: ''
+ delete:
+ operationId: extras_dynamic_group_memberships_destroy
+ description: Manage Dynamic Group Memberships 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 membership.
+ 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/DynamicGroupRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableDynamicGroupRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableDynamicGroupRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/DynamicGroupRequest'
+ 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/PatchedDynamicGroupRequest'
+ 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/dynamic-groups/{id}/notes/:
+ get:
+ operationId: extras_dynamic_groups_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this dynamic group.
+ 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/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: extras_dynamic_groups_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ 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/ExportTemplateRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableExportTemplateRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableExportTemplateRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/ExportTemplateRequest'
+ 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/PatchedExportTemplateRequest'
+ 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/export-templates/{id}/notes/:
+ get:
+ operationId: extras_export_templates_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this export template.
+ 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/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: extras_export_templates_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /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: provided_contents
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - 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/WritableGitRepositoryRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableGitRepositoryRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableGitRepositoryRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/WritableGitRepositoryRequest'
+ 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/PatchedWritableGitRepositoryRequest'
+ 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}/notes/:
+ get:
+ operationId: extras_git_repositories_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this Git repository.
+ 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/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: extras_git_repositories_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /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/GitRepositoryRequest'
+ 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:
+ - 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: 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/GraphQLQueryRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableGraphQLQueryRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableGraphQLQueryRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/GraphQLQueryRequest'
+ 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/PatchedGraphQLQueryRequest'
+ 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}/notes/:
+ get:
+ operationId: extras_graphql_queries_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this GraphQL query.
+ 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/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: extras_graphql_queries_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /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/GraphQLQueryInputRequest'
+ 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/ImageAttachmentRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableImageAttachmentRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableImageAttachmentRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/ImageAttachmentRequest'
+ 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/PatchedImageAttachmentRequest'
+ 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-hooks/:
+ get:
+ operationId: extras_job_hooks_list
+ description: Manage job hooks 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
+ - 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
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Job (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: job__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Job (slug or 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: 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: 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/PaginatedJobHookList'
+ description: ''
+ post:
+ operationId: extras_job_hooks_create
+ description: Manage job hooks through DELETE, GET, POST, PUT, and PATCH requests.
+ tags:
+ - extras
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/JobHookRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/JobHook'
+ description: ''
+ put:
+ operationId: extras_job_hooks_bulk_update
+ description: Manage job hooks through DELETE, GET, POST, PUT, and PATCH requests.
+ tags:
+ - extras
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableJobHookRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/JobHook'
+ description: ''
+ patch:
+ operationId: extras_job_hooks_bulk_partial_update
+ description: Manage job hooks through DELETE, GET, POST, PUT, and PATCH requests.
+ tags:
+ - extras
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableJobHookRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/JobHook'
+ description: ''
+ delete:
+ operationId: extras_job_hooks_bulk_destroy
+ description: Manage job hooks through DELETE, GET, POST, PUT, and PATCH requests.
+ tags:
+ - extras
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /extras/job-hooks/{id}/:
+ get:
+ operationId: extras_job_hooks_retrieve
+ description: Manage job hooks through DELETE, GET, POST, PUT, and PATCH requests.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this job hook.
+ required: true
+ tags:
+ - extras
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/JobHook'
+ description: ''
+ put:
+ operationId: extras_job_hooks_update
+ description: Manage job hooks through DELETE, GET, POST, PUT, and PATCH requests.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this job hook.
+ required: true
+ tags:
+ - extras
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/JobHookRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/JobHook'
+ description: ''
+ patch:
+ operationId: extras_job_hooks_partial_update
+ description: Manage job hooks through DELETE, GET, POST, PUT, and PATCH requests.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this job hook.
+ required: true
+ tags:
+ - extras
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PatchedJobHookRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/JobHook'
+ description: ''
+ delete:
+ operationId: extras_job_hooks_destroy
+ description: Manage job hooks through DELETE, GET, POST, PUT, and PATCH requests.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this job hook.
+ required: true
+ tags:
+ - extras
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ /extras/job-hooks/{id}/notes/:
+ get:
+ operationId: extras_job_hooks_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this job hook.
+ 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/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: extras_job_hooks_notes_create
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this job hook.
+ required: true
+ tags:
+ - extras
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /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: ''
+ 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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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: ''
+ 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: has_sensitive_variables
+ schema:
+ type: boolean
+ - in: query
+ name: has_sensitive_variables_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: is_job_hook_receiver
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableJobRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/Job'
+ description: ''
+ patch:
+ operationId: extras_jobs_bulk_partial_update
+ tags:
+ - extras
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableJobRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/Job'
+ description: ''
+ delete:
+ operationId: extras_jobs_bulk_destroy
+ tags:
+ - extras
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/JobInputRequest'
+ multipart/form-data:
+ schema:
+ $ref: '#/components/schemas/JobInputRequest'
+ 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/JobRequest'
+ 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/PatchedJobRequest'
+ 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}/notes/:
+ get:
+ operationId: extras_jobs_notes_list
+ description: API methods for returning or creating notes on an object.
+ 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/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: extras_jobs_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /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/JobInputRequest'
+ multipart/form-data:
+ schema:
+ $ref: '#/components/schemas/JobMultiPartInputRequest'
+ 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/notes/:
+ get:
+ operationId: extras_notes_list
+ description: Extend DRF's ModelViewSet to support bulk update and delete functions.
+ parameters:
+ - in: query
+ name: assigned_object_id
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: assigned_object_id__ic
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: assigned_object_id__ie
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: assigned_object_id__iew
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: assigned_object_id__ire
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: assigned_object_id__isw
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: assigned_object_id__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: assigned_object_id__nic
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: assigned_object_id__nie
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: assigned_object_id__niew
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: assigned_object_id__nire
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: assigned_object_id__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: assigned_object_id__nre
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: assigned_object_id__re
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: assigned_object_type
+ schema:
+ type: string
+ - in: query
+ name: assigned_object_type__n
+ schema:
+ type: string
+ - in: query
+ name: assigned_object_type_id
+ schema:
+ type: integer
+ - in: query
+ name: assigned_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: note
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: note__ic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: note__ie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: note__iew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: note__ire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: note__isw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: note__n
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: note__nic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: note__nie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: note__niew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: note__nire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: note__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: note__nre
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: note__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: user
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: User (username or ID)
+ explode: true
+ style: form
+ - in: query
+ name: user__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: User (username or 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/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: extras_notes_create
+ description: Extend DRF's ModelViewSet to support bulk update and delete functions.
+ tags:
+ - extras
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/NoteRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ put:
+ operationId: extras_notes_bulk_update
+ description: Extend DRF's ModelViewSet to support bulk update and delete functions.
+ tags:
+ - extras
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableNoteRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ patch:
+ operationId: extras_notes_bulk_partial_update
+ description: Extend DRF's ModelViewSet to support bulk update and delete functions.
+ tags:
+ - extras
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableNoteRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ delete:
+ operationId: extras_notes_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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /extras/notes/{id}/:
+ get:
+ operationId: extras_notes_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 note.
+ required: true
+ tags:
+ - extras
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ put:
+ operationId: extras_notes_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 note.
+ required: true
+ tags:
+ - extras
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/NoteRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ patch:
+ operationId: extras_notes_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 note.
+ required: true
+ tags:
+ - extras
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PatchedNoteRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ delete:
+ operationId: extras_notes_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 note.
+ required: true
+ tags:
+ - extras
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ /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: peer_id
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - 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/WritableRelationshipAssociationRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableRelationshipAssociationRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableRelationshipAssociationRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/WritableRelationshipAssociationRequest'
+ 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/PatchedWritableRelationshipAssociationRequest'
+ 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: 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: 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/RelationshipRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableRelationshipRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableRelationshipRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/RelationshipRequest'
+ 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/PatchedRelationshipRequest'
+ 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/relationships/{id}/notes/:
+ get:
+ operationId: extras_relationships_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this relationship.
+ 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/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: extras_relationships_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /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/SecretRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableSecretRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableSecretRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/SecretsGroupRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableSecretsGroupRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableSecretsGroupRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/WritableSecretsGroupAssociationRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableSecretsGroupAssociationRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableSecretsGroupAssociationRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/WritableSecretsGroupAssociationRequest'
+ 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/PatchedWritableSecretsGroupAssociationRequest'
+ 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/SecretsGroupRequest'
+ 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/PatchedSecretsGroupRequest'
+ 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-groups/{id}/notes/:
+ get:
+ operationId: extras_secrets_groups_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this secrets group.
+ 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/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: extras_secrets_groups_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /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/SecretRequest'
+ 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/PatchedSecretRequest'
+ 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/secrets/{id}/notes/:
+ get:
+ operationId: extras_secrets_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this secret.
+ 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/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: extras_secrets_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /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/StatusRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableStatusRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableStatusRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/StatusRequest'
+ 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/PatchedStatusRequest'
+ 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/statuses/{id}/notes/:
+ get:
+ operationId: extras_statuses_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this status.
+ 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/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: extras_statuses_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /extras/tags/:
+ get:
+ operationId: extras_tags_list
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - extras
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/TagSerializerVersion13Request'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - extras
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableTagSerializerVersion13Request'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerVersion13'
+ description: ''
+ patch:
+ operationId: extras_tags_bulk_partial_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - extras
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableTagSerializerVersion13Request'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerVersion13'
+ description: ''
+ delete:
+ operationId: extras_tags_bulk_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - extras
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /extras/tags/{id}/:
+ get:
+ operationId: extras_tags_retrieve
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/TagSerializerVersion13Request'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/PatchedTagSerializerVersion13Request'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/TagSerializerVersion13'
+ description: ''
+ delete:
+ operationId: extras_tags_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/tags/{id}/notes/:
+ get:
+ operationId: extras_tags_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this tag.
+ 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/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: extras_tags_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /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
+ - 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: 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/WebhookRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableWebhookRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableWebhookRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/WebhookRequest'
+ 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/PatchedWebhookRequest'
+ 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
+ /extras/webhooks/{id}/notes/:
+ get:
+ operationId: extras_webhooks_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this webhook.
+ 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/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: extras_webhooks_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /graphql/:
+ post:
+ operationId: graphql_create
+ description: Query the database using a GraphQL query
+ tags:
+ - graphql
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/GraphQLAPIRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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
+ format: uuid
+ description: Tenant (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: tenant__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Tenant (slug or ID)
+ 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) (deprecated, use "tenant" filter instead)
+ explode: true
+ style: form
+ - in: query
+ name: tenant_id__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ nullable: true
+ description: Tenant (ID) (deprecated, use "tenant" filter instead)
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - ipam
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableAggregateRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - ipam
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableAggregateRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/Aggregate'
+ description: ''
+ patch:
+ operationId: ipam_aggregates_bulk_partial_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - ipam
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableAggregateRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/Aggregate'
+ description: ''
+ delete:
+ operationId: ipam_aggregates_bulk_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - ipam
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /ipam/aggregates/{id}/:
+ get:
+ operationId: ipam_aggregates_retrieve
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/WritableAggregateRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/PatchedWritableAggregateRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Aggregate'
+ description: ''
+ delete:
+ operationId: ipam_aggregates_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/aggregates/{id}/notes/:
+ get:
+ operationId: ipam_aggregates_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this aggregate.
+ 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/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: ipam_aggregates_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /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
+ - in: query
+ name: nautobot_bgp_models_ips_bgp_routing_instance
+ schema:
+ type: array
+ items:
+ type: string
+ description: Routing Instance UUID
+ explode: true
+ style: form
+ - in: query
+ name: nautobot_bgp_models_ips_bgp_routing_instance__ic
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: nautobot_bgp_models_ips_bgp_routing_instance__ie
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: nautobot_bgp_models_ips_bgp_routing_instance__iew
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: nautobot_bgp_models_ips_bgp_routing_instance__ire
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: nautobot_bgp_models_ips_bgp_routing_instance__isw
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: nautobot_bgp_models_ips_bgp_routing_instance__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: nautobot_bgp_models_ips_bgp_routing_instance__nic
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: nautobot_bgp_models_ips_bgp_routing_instance__nie
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: nautobot_bgp_models_ips_bgp_routing_instance__niew
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: nautobot_bgp_models_ips_bgp_routing_instance__nire
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: nautobot_bgp_models_ips_bgp_routing_instance__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: nautobot_bgp_models_ips_bgp_routing_instance__nre
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: nautobot_bgp_models_ips_bgp_routing_instance__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
+ - 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
+ format: uuid
+ description: Tenant (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: tenant__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Tenant (slug or ID)
+ 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) (deprecated, use "tenant" filter instead)
+ explode: true
+ style: form
+ - in: query
+ name: tenant_id__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ nullable: true
+ description: Tenant (ID) (deprecated, use "tenant" filter instead)
+ 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/WritableIPAddressRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableIPAddressRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableIPAddressRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/WritableIPAddressRequest'
+ 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/PatchedWritableIPAddressRequest'
+ 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/ip-addresses/{id}/notes/:
+ get:
+ operationId: ipam_ip_addresses_notes_list
+ description: API methods for returning or creating notes on an object.
+ 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/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: ipam_ip_addresses_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /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: location
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Location (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: location__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Location (slug or ID)
+ explode: true
+ style: form
+ - 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 or ID)
+ explode: true
+ style: form
+ - in: query
+ name: region__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Region (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: region_id
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Region (ID) (deprecated, use "region" filter instead)
+ explode: true
+ style: form
+ - in: query
+ name: region_id__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Region (ID) (deprecated, use "region" filter instead)
+ 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
+ format: uuid
+ description: Site (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: site__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Site (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: site_id
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ nullable: true
+ description: Site (ID) (deprecated, use "site" filter instead)
+ explode: true
+ style: form
+ - in: query
+ name: site_id__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ nullable: true
+ description: Site (ID) (deprecated, use "site" filter instead)
+ 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
+ format: uuid
+ description: Tenant (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: tenant__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Tenant (slug or ID)
+ 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) (deprecated, use "tenant" filter instead)
+ explode: true
+ style: form
+ - in: query
+ name: tenant_id__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ nullable: true
+ description: Tenant (ID) (deprecated, use "tenant" filter instead)
+ 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/WritablePrefixRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritablePrefixRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritablePrefixRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/WritablePrefixRequest'
+ 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/PatchedWritablePrefixRequest'
+ 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
+ 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/PrefixLengthRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Prefix'
+ description: ''
+ /ipam/prefixes/{id}/notes/:
+ get:
+ operationId: ipam_prefixes_notes_list
+ description: API methods for returning or creating notes on an object.
+ 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/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: ipam_prefixes_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /ipam/rirs/:
+ get:
+ operationId: ipam_rirs_list
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - ipam
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RIRRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - ipam
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableRIRRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/RIR'
+ description: ''
+ patch:
+ operationId: ipam_rirs_bulk_partial_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - ipam
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableRIRRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/RIR'
+ description: ''
+ delete:
+ operationId: ipam_rirs_bulk_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - ipam
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /ipam/rirs/{id}/:
+ get:
+ operationId: ipam_rirs_retrieve
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/RIRRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/PatchedRIRRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/RIR'
+ description: ''
+ delete:
+ operationId: ipam_rirs_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/rirs/{id}/notes/:
+ get:
+ operationId: ipam_rirs_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this RIR.
+ 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/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: ipam_rirs_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /ipam/roles/:
+ get:
+ operationId: ipam_roles_list
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - ipam
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RoleRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - ipam
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableRoleRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/Role'
+ description: ''
+ patch:
+ operationId: ipam_roles_bulk_partial_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - ipam
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableRoleRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/Role'
+ description: ''
+ delete:
+ operationId: ipam_roles_bulk_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - ipam
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /ipam/roles/{id}/:
+ get:
+ operationId: ipam_roles_retrieve
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/RoleRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/PatchedRoleRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Role'
+ description: ''
+ delete:
+ operationId: ipam_roles_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/roles/{id}/notes/:
+ get:
+ operationId: ipam_roles_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this role.
+ 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/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: ipam_roles_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /ipam/route-targets/:
+ get:
+ operationId: ipam_route_targets_list
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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
+ format: uuid
+ description: Tenant (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: tenant__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Tenant (slug or ID)
+ 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) (deprecated, use "tenant" filter instead)
+ explode: true
+ style: form
+ - in: query
+ name: tenant_id__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ nullable: true
+ description: Tenant (ID) (deprecated, use "tenant" filter instead)
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - ipam
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableRouteTargetRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - ipam
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableRouteTargetRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/RouteTarget'
+ description: ''
+ patch:
+ operationId: ipam_route_targets_bulk_partial_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - ipam
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableRouteTargetRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/RouteTarget'
+ description: ''
+ delete:
+ operationId: ipam_route_targets_bulk_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - ipam
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /ipam/route-targets/{id}/:
+ get:
+ operationId: ipam_route_targets_retrieve
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/WritableRouteTargetRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/PatchedWritableRouteTargetRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/RouteTarget'
+ description: ''
+ delete:
+ operationId: ipam_route_targets_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/route-targets/{id}/notes/:
+ get:
+ operationId: ipam_route_targets_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this route target.
+ 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/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: ipam_route_targets_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /ipam/services/:
+ get:
+ operationId: ipam_services_list
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - ipam
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableServiceRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - ipam
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableServiceRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/Service'
+ description: ''
+ patch:
+ operationId: ipam_services_bulk_partial_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - ipam
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableServiceRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/Service'
+ description: ''
+ delete:
+ operationId: ipam_services_bulk_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - ipam
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /ipam/services/{id}/:
+ get:
+ operationId: ipam_services_retrieve
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/WritableServiceRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/PatchedWritableServiceRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Service'
+ description: ''
+ delete:
+ operationId: ipam_services_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/services/{id}/notes/:
+ get:
+ operationId: ipam_services_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this service.
+ 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/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: ipam_services_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /ipam/vlan-groups/:
+ get:
+ operationId: ipam_vlan_groups_list
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: location
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Location (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: location__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Location (slug or 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 or ID)
+ explode: true
+ style: form
+ - in: query
+ name: region__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Region (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: region_id
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Region (ID) (deprecated, use "region" filter instead)
+ explode: true
+ style: form
+ - in: query
+ name: region_id__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Region (ID) (deprecated, use "region" filter instead)
+ explode: true
+ style: form
+ - in: query
+ name: site
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Site (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: site__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Site (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: site_id
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ nullable: true
+ description: Site (ID) (deprecated, use "site" filter instead)
+ explode: true
+ style: form
+ - in: query
+ name: site_id__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ nullable: true
+ description: Site (ID) (deprecated, use "site" filter instead)
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - ipam
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableVLANGroupRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - ipam
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableVLANGroupRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/VLANGroup'
+ description: ''
+ patch:
+ operationId: ipam_vlan_groups_bulk_partial_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - ipam
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableVLANGroupRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/VLANGroup'
+ description: ''
+ delete:
+ operationId: ipam_vlan_groups_bulk_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - ipam
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /ipam/vlan-groups/{id}/:
+ get:
+ operationId: ipam_vlan_groups_retrieve
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/WritableVLANGroupRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/PatchedWritableVLANGroupRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/VLANGroup'
+ description: ''
+ delete:
+ operationId: ipam_vlan_groups_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/vlan-groups/{id}/notes/:
+ get:
+ operationId: ipam_vlan_groups_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this VLAN group.
+ 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/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: ipam_vlan_groups_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /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: available_on_device
+ schema:
+ type: string
+ format: uuid
+ description: Device (ID)
+ - 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: location
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Location (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: location__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Location (slug or 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 or ID)
+ explode: true
+ style: form
+ - in: query
+ name: region__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Region (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: region_id
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Region (ID) (deprecated, use "region" filter instead)
+ explode: true
+ style: form
+ - in: query
+ name: region_id__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Region (ID) (deprecated, use "region" filter instead)
+ 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
+ format: uuid
+ description: Site (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: site__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Site (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: site_id
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ nullable: true
+ description: Site (ID) (deprecated, use "site" filter instead)
+ explode: true
+ style: form
+ - in: query
+ name: site_id__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ nullable: true
+ description: Site (ID) (deprecated, use "site" filter instead)
+ 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
+ format: uuid
+ description: Tenant (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: tenant__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Tenant (slug or ID)
+ 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) (deprecated, use "tenant" filter instead)
+ explode: true
+ style: form
+ - in: query
+ name: tenant_id__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ nullable: true
+ description: Tenant (ID) (deprecated, use "tenant" filter instead)
+ 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/WritableVLANRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableVLANRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableVLANRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/WritableVLANRequest'
+ 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/PatchedWritableVLANRequest'
+ 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/vlans/{id}/notes/:
+ get:
+ operationId: ipam_vlans_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this VLAN.
+ 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/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: ipam_vlans_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /ipam/vrfs/:
+ get:
+ operationId: ipam_vrfs_list
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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
+ format: uuid
+ description: Tenant (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: tenant__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Tenant (slug or ID)
+ 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) (deprecated, use "tenant" filter instead)
+ explode: true
+ style: form
+ - in: query
+ name: tenant_id__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ nullable: true
+ description: Tenant (ID) (deprecated, use "tenant" filter instead)
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - ipam
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableVRFRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - ipam
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableVRFRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/VRF'
+ description: ''
+ patch:
+ operationId: ipam_vrfs_bulk_partial_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - ipam
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableVRFRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/VRF'
+ description: ''
+ delete:
+ operationId: ipam_vrfs_bulk_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - ipam
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /ipam/vrfs/{id}/:
+ get:
+ operationId: ipam_vrfs_retrieve
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/WritableVRFRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/PatchedWritableVRFRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/VRF'
+ description: ''
+ delete:
+ operationId: ipam_vrfs_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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
+ /ipam/vrfs/{id}/notes/:
+ get:
+ operationId: ipam_vrfs_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this VRF.
+ 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/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: ipam_vrfs_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /plugins/bgp/address-families/:
+ get:
+ operationId: plugins_bgp_address_families_list
+ description: List all objects of this type.
+ parameters:
+ - in: query
+ name: afi_safi
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: afi_safi__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: 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_inherited
+ schema:
+ type: boolean
+ description: Include inherited configuration values
+ - 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: routing_instance
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: BGP Routing Instance ID
+ explode: true
+ style: form
+ - in: query
+ name: routing_instance__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: BGP Routing Instance ID
+ explode: true
+ style: form
+ - in: query
+ name: vrf
+ schema:
+ type: array
+ items:
+ type: string
+ description: VRF (name)
+ explode: true
+ style: form
+ - in: query
+ name: vrf__n
+ schema:
+ type: array
+ items:
+ type: string
+ description: VRF (name)
+ explode: true
+ style: form
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedAddressFamilyList'
+ description: ''
+ post:
+ operationId: plugins_bgp_address_families_create
+ description: REST API viewset for AddressFamily records.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableAddressFamilyRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/AddressFamily'
+ description: ''
+ put:
+ operationId: plugins_bgp_address_families_bulk_update
+ description: REST API viewset for AddressFamily records.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableAddressFamilyRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/AddressFamily'
+ description: ''
+ patch:
+ operationId: plugins_bgp_address_families_bulk_partial_update
+ description: REST API viewset for AddressFamily records.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableAddressFamilyRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/AddressFamily'
+ description: ''
+ delete:
+ operationId: plugins_bgp_address_families_bulk_destroy
+ description: REST API viewset for AddressFamily records.
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /plugins/bgp/address-families/{id}/:
+ get:
+ operationId: plugins_bgp_address_families_retrieve
+ description: Retrieve a specific object instance.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this BGP address family.
+ required: true
+ - in: query
+ name: include_inherited
+ schema:
+ type: boolean
+ description: Include inherited configuration values
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/AddressFamily'
+ description: ''
+ put:
+ operationId: plugins_bgp_address_families_update
+ description: REST API viewset for AddressFamily records.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this BGP address family.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableAddressFamilyRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/AddressFamily'
+ description: ''
+ patch:
+ operationId: plugins_bgp_address_families_partial_update
+ description: REST API viewset for AddressFamily records.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this BGP address family.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PatchedWritableAddressFamilyRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/AddressFamily'
+ description: ''
+ delete:
+ operationId: plugins_bgp_address_families_destroy
+ description: REST API viewset for AddressFamily records.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this BGP address family.
+ required: true
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ /plugins/bgp/autonomous-systems/:
+ get:
+ operationId: plugins_bgp_autonomous_systems_list
+ description: REST API viewset for AutonomousSystem records.
+ 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: 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
+ - 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
+ 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
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedAutonomousSystemList'
+ description: ''
+ post:
+ operationId: plugins_bgp_autonomous_systems_create
+ description: REST API viewset for AutonomousSystem records.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableAutonomousSystemRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/AutonomousSystem'
+ description: ''
+ put:
+ operationId: plugins_bgp_autonomous_systems_bulk_update
+ description: REST API viewset for AutonomousSystem records.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableAutonomousSystemRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/AutonomousSystem'
+ description: ''
+ patch:
+ operationId: plugins_bgp_autonomous_systems_bulk_partial_update
+ description: REST API viewset for AutonomousSystem records.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableAutonomousSystemRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/AutonomousSystem'
+ description: ''
+ delete:
+ operationId: plugins_bgp_autonomous_systems_bulk_destroy
+ description: REST API viewset for AutonomousSystem records.
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /plugins/bgp/autonomous-systems/{id}/:
+ get:
+ operationId: plugins_bgp_autonomous_systems_retrieve
+ description: REST API viewset for AutonomousSystem records.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this Autonomous system.
+ required: true
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/AutonomousSystem'
+ description: ''
+ put:
+ operationId: plugins_bgp_autonomous_systems_update
+ description: REST API viewset for AutonomousSystem records.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this Autonomous system.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableAutonomousSystemRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/AutonomousSystem'
+ description: ''
+ patch:
+ operationId: plugins_bgp_autonomous_systems_partial_update
+ description: REST API viewset for AutonomousSystem records.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this Autonomous system.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PatchedWritableAutonomousSystemRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/AutonomousSystem'
+ description: ''
+ delete:
+ operationId: plugins_bgp_autonomous_systems_destroy
+ description: REST API viewset for AutonomousSystem records.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this Autonomous system.
+ required: true
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ /plugins/bgp/peer-endpoints/:
+ get:
+ operationId: plugins_bgp_peer_endpoints_list
+ description: List all objects of this type.
+ parameters:
+ - name: autonomous_system
+ required: false
+ in: query
+ description: Autonomous System Number
+ schema:
+ type: string
+ - name: autonomous_system__n
+ required: false
+ in: query
+ description: Autonomous System Number
+ schema:
+ type: string
+ - name: device
+ required: false
+ in: query
+ description: Device (name)
+ schema:
+ type: string
+ - name: device__n
+ required: false
+ in: query
+ description: Device (name)
+ schema:
+ type: string
+ - name: enabled
+ required: false
+ in: query
+ description: enabled
+ schema:
+ type: string
+ - name: id
+ required: false
+ in: query
+ description: id
+ schema:
+ type: string
+ - name: id__ic
+ required: false
+ in: query
+ description: id__ic
+ schema:
+ type: string
+ - name: id__ie
+ required: false
+ in: query
+ description: id__ie
+ schema:
+ type: string
+ - name: id__iew
+ required: false
+ in: query
+ description: id__iew
+ schema:
+ type: string
+ - name: id__ire
+ required: false
+ in: query
+ description: id__ire
+ schema:
+ type: string
+ - name: id__isw
+ required: false
+ in: query
+ description: id__isw
+ schema:
+ type: string
+ - name: id__n
+ required: false
+ in: query
+ description: id__n
+ schema:
+ type: string
+ - name: id__nic
+ required: false
+ in: query
+ description: id__nic
+ schema:
+ type: string
+ - name: id__nie
+ required: false
+ in: query
+ description: id__nie
+ schema:
+ type: string
+ - name: id__niew
+ required: false
+ in: query
+ description: id__niew
+ schema:
+ type: string
+ - name: id__nire
+ required: false
+ in: query
+ description: id__nire
+ schema:
+ type: string
+ - name: id__nisw
+ required: false
+ in: query
+ description: id__nisw
+ schema:
+ type: string
+ - name: id__nre
+ required: false
+ in: query
+ description: id__nre
+ schema:
+ type: string
+ - name: id__re
+ required: false
+ in: query
+ description: id__re
+ schema:
+ type: string
+ - in: query
+ name: include_inherited
+ schema:
+ type: boolean
+ description: Include inherited configuration values
+ - 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
+ - name: peer_group
+ required: false
+ in: query
+ description: Peer Group (id)
+ schema:
+ type: string
+ - name: peer_group__n
+ required: false
+ in: query
+ description: Peer Group (id)
+ schema:
+ type: string
+ - name: q
+ required: false
+ in: query
+ description: Search
+ schema:
+ type: string
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedPeerEndpointList'
+ description: ''
+ post:
+ operationId: plugins_bgp_peer_endpoints_create
+ description: REST API viewset for PeerEndpoint records.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritablePeerEndpointRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PeerEndpoint'
+ description: ''
+ put:
+ operationId: plugins_bgp_peer_endpoints_bulk_update
+ description: REST API viewset for PeerEndpoint records.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritablePeerEndpointRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PeerEndpoint'
+ description: ''
+ patch:
+ operationId: plugins_bgp_peer_endpoints_bulk_partial_update
+ description: REST API viewset for PeerEndpoint records.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritablePeerEndpointRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PeerEndpoint'
+ description: ''
+ delete:
+ operationId: plugins_bgp_peer_endpoints_bulk_destroy
+ description: REST API viewset for PeerEndpoint records.
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /plugins/bgp/peer-endpoints/{id}/:
+ get:
+ operationId: plugins_bgp_peer_endpoints_retrieve
+ description: Retrieve a specific object instance.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this peer endpoint.
+ required: true
+ - in: query
+ name: include_inherited
+ schema:
+ type: boolean
+ description: Include inherited configuration values
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PeerEndpoint'
+ description: ''
+ put:
+ operationId: plugins_bgp_peer_endpoints_update
+ description: REST API viewset for PeerEndpoint records.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this peer endpoint.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritablePeerEndpointRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PeerEndpoint'
+ description: ''
+ patch:
+ operationId: plugins_bgp_peer_endpoints_partial_update
+ description: REST API viewset for PeerEndpoint records.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this peer endpoint.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PatchedWritablePeerEndpointRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PeerEndpoint'
+ description: ''
+ delete:
+ operationId: plugins_bgp_peer_endpoints_destroy
+ description: REST API viewset for PeerEndpoint records.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this peer endpoint.
+ required: true
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ /plugins/bgp/peer-group-templates/:
+ get:
+ operationId: plugins_bgp_peer_group_templates_list
+ description: List all objects of this type.
+ parameters:
+ - in: query
+ name: autonomous_system
+ schema:
+ type: array
+ items:
+ type: integer
+ maximum: 4294967295
+ minimum: 1
+ format: int64
+ description: Autonomous System Number
+ explode: true
+ style: form
+ - in: query
+ name: autonomous_system__n
+ schema:
+ type: array
+ items:
+ type: integer
+ maximum: 4294967295
+ minimum: 1
+ format: int64
+ description: Autonomous System Number
+ 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: include_inherited
+ schema:
+ type: boolean
+ description: Include inherited configuration values
+ - 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: role
+ schema:
+ type: array
+ items:
+ type: string
+ description: Peering role (slug)
+ explode: true
+ style: form
+ - in: query
+ name: role__n
+ schema:
+ type: array
+ items:
+ type: string
+ description: Peering role (slug)
+ explode: true
+ style: form
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedPeerGroupTemplateList'
+ description: ''
+ post:
+ operationId: plugins_bgp_peer_group_templates_create
+ description: REST API viewset for PeerGroupTemplate records.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritablePeerGroupTemplateRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PeerGroupTemplate'
+ description: ''
+ put:
+ operationId: plugins_bgp_peer_group_templates_bulk_update
+ description: REST API viewset for PeerGroupTemplate records.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritablePeerGroupTemplateRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PeerGroupTemplate'
+ description: ''
+ patch:
+ operationId: plugins_bgp_peer_group_templates_bulk_partial_update
+ description: REST API viewset for PeerGroupTemplate records.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritablePeerGroupTemplateRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PeerGroupTemplate'
+ description: ''
+ delete:
+ operationId: plugins_bgp_peer_group_templates_bulk_destroy
+ description: REST API viewset for PeerGroupTemplate records.
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /plugins/bgp/peer-group-templates/{id}/:
+ get:
+ operationId: plugins_bgp_peer_group_templates_retrieve
+ description: Retrieve a specific object instance.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this BGP Peer Group Template.
+ required: true
+ - in: query
+ name: include_inherited
+ schema:
+ type: boolean
+ description: Include inherited configuration values
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PeerGroupTemplate'
+ description: ''
+ put:
+ operationId: plugins_bgp_peer_group_templates_update
+ description: REST API viewset for PeerGroupTemplate records.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this BGP Peer Group Template.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritablePeerGroupTemplateRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PeerGroupTemplate'
+ description: ''
+ patch:
+ operationId: plugins_bgp_peer_group_templates_partial_update
+ description: REST API viewset for PeerGroupTemplate records.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this BGP Peer Group Template.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PatchedWritablePeerGroupTemplateRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PeerGroupTemplate'
+ description: ''
+ delete:
+ operationId: plugins_bgp_peer_group_templates_destroy
+ description: REST API viewset for PeerGroupTemplate records.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this BGP Peer Group Template.
+ required: true
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ /plugins/bgp/peer-groups/:
+ get:
+ operationId: plugins_bgp_peer_groups_list
+ description: List all objects of this type.
+ parameters:
+ - name: autonomous_system
+ required: false
+ in: query
+ description: Autonomous System Number
+ schema:
+ type: string
+ - name: autonomous_system__n
+ required: false
+ in: query
+ description: Autonomous System Number
+ schema:
+ type: string
+ - name: enabled
+ required: false
+ in: query
+ description: enabled
+ schema:
+ type: string
+ - name: id
+ required: false
+ in: query
+ description: id
+ schema:
+ type: string
+ - name: id__ic
+ required: false
+ in: query
+ description: id__ic
+ schema:
+ type: string
+ - name: id__ie
+ required: false
+ in: query
+ description: id__ie
+ schema:
+ type: string
+ - name: id__iew
+ required: false
+ in: query
+ description: id__iew
+ schema:
+ type: string
+ - name: id__ire
+ required: false
+ in: query
+ description: id__ire
+ schema:
+ type: string
+ - name: id__isw
+ required: false
+ in: query
+ description: id__isw
+ schema:
+ type: string
+ - name: id__n
+ required: false
+ in: query
+ description: id__n
+ schema:
+ type: string
+ - name: id__nic
+ required: false
+ in: query
+ description: id__nic
+ schema:
+ type: string
+ - name: id__nie
+ required: false
+ in: query
+ description: id__nie
+ schema:
+ type: string
+ - name: id__niew
+ required: false
+ in: query
+ description: id__niew
+ schema:
+ type: string
+ - name: id__nire
+ required: false
+ in: query
+ description: id__nire
+ schema:
+ type: string
+ - name: id__nisw
+ required: false
+ in: query
+ description: id__nisw
+ schema:
+ type: string
+ - name: id__nre
+ required: false
+ in: query
+ description: id__nre
+ schema:
+ type: string
+ - name: id__re
+ required: false
+ in: query
+ description: id__re
+ schema:
+ type: string
+ - in: query
+ name: include_inherited
+ schema:
+ type: boolean
+ description: Include inherited configuration values
+ - name: limit
+ required: false
+ in: query
+ description: Number of results to return per page.
+ schema:
+ type: integer
+ - name: name
+ required: false
+ in: query
+ description: name
+ schema:
+ type: string
+ - name: name__ic
+ required: false
+ in: query
+ description: name__ic
+ schema:
+ type: string
+ - name: name__ie
+ required: false
+ in: query
+ description: name__ie
+ schema:
+ type: string
+ - name: name__iew
+ required: false
+ in: query
+ description: name__iew
+ schema:
+ type: string
+ - name: name__ire
+ required: false
+ in: query
+ description: name__ire
+ schema:
+ type: string
+ - name: name__isw
+ required: false
+ in: query
+ description: name__isw
+ schema:
+ type: string
+ - name: name__n
+ required: false
+ in: query
+ description: name__n
+ schema:
+ type: string
+ - name: name__nic
+ required: false
+ in: query
+ description: name__nic
+ schema:
+ type: string
+ - name: name__nie
+ required: false
+ in: query
+ description: name__nie
+ schema:
+ type: string
+ - name: name__niew
+ required: false
+ in: query
+ description: name__niew
+ schema:
+ type: string
+ - name: name__nire
+ required: false
+ in: query
+ description: name__nire
+ schema:
+ type: string
+ - name: name__nisw
+ required: false
+ in: query
+ description: name__nisw
+ schema:
+ type: string
+ - name: name__nre
+ required: false
+ in: query
+ description: name__nre
+ schema:
+ type: string
+ - name: name__re
+ required: false
+ in: query
+ description: name__re
+ schema:
+ type: string
+ - name: offset
+ required: false
+ in: query
+ description: The initial index from which to return the results.
+ schema:
+ type: integer
+ - name: q
+ required: false
+ in: query
+ description: Search
+ schema:
+ type: string
+ - name: role
+ required: false
+ in: query
+ description: Peering role (slug)
+ schema:
+ type: string
+ - name: role__n
+ required: false
+ in: query
+ description: Peering role (slug)
+ schema:
+ type: string
+ - name: routing_instance
+ required: false
+ in: query
+ description: BGP Routing Instance ID
+ schema:
+ type: string
+ - name: routing_instance__n
+ required: false
+ in: query
+ description: BGP Routing Instance ID
+ schema:
+ type: string
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedPeerGroupList'
+ description: ''
+ post:
+ operationId: plugins_bgp_peer_groups_create
+ description: REST API viewset for PeerGroup records.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritablePeerGroupRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PeerGroup'
+ description: ''
+ put:
+ operationId: plugins_bgp_peer_groups_bulk_update
+ description: REST API viewset for PeerGroup records.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritablePeerGroupRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PeerGroup'
+ description: ''
+ patch:
+ operationId: plugins_bgp_peer_groups_bulk_partial_update
+ description: REST API viewset for PeerGroup records.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritablePeerGroupRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PeerGroup'
+ description: ''
+ delete:
+ operationId: plugins_bgp_peer_groups_bulk_destroy
+ description: REST API viewset for PeerGroup records.
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /plugins/bgp/peer-groups/{id}/:
+ get:
+ operationId: plugins_bgp_peer_groups_retrieve
+ description: Retrieve a specific object instance.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this BGP Peer Group.
+ required: true
+ - in: query
+ name: include_inherited
+ schema:
+ type: boolean
+ description: Include inherited configuration values
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PeerGroup'
+ description: ''
+ put:
+ operationId: plugins_bgp_peer_groups_update
+ description: REST API viewset for PeerGroup records.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this BGP Peer Group.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritablePeerGroupRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PeerGroup'
+ description: ''
+ patch:
+ operationId: plugins_bgp_peer_groups_partial_update
+ description: REST API viewset for PeerGroup records.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this BGP Peer Group.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PatchedWritablePeerGroupRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PeerGroup'
+ description: ''
+ delete:
+ operationId: plugins_bgp_peer_groups_destroy
+ description: REST API viewset for PeerGroup records.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this BGP Peer Group.
+ required: true
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ /plugins/bgp/peering-roles/:
+ get:
+ operationId: plugins_bgp_peering_roles_list
+ description: REST API viewset for PeeringRole records.
+ 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: 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:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedPeeringRoleList'
+ description: ''
+ post:
+ operationId: plugins_bgp_peering_roles_create
+ description: REST API viewset for PeeringRole records.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PeeringRoleRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PeeringRole'
+ description: ''
+ put:
+ operationId: plugins_bgp_peering_roles_bulk_update
+ description: REST API viewset for PeeringRole records.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritablePeeringRoleRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PeeringRole'
+ description: ''
+ patch:
+ operationId: plugins_bgp_peering_roles_bulk_partial_update
+ description: REST API viewset for PeeringRole records.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritablePeeringRoleRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PeeringRole'
+ description: ''
+ delete:
+ operationId: plugins_bgp_peering_roles_bulk_destroy
+ description: REST API viewset for PeeringRole records.
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /plugins/bgp/peering-roles/{id}/:
+ get:
+ operationId: plugins_bgp_peering_roles_retrieve
+ description: REST API viewset for PeeringRole records.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this BGP Peering Role.
+ required: true
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PeeringRole'
+ description: ''
+ put:
+ operationId: plugins_bgp_peering_roles_update
+ description: REST API viewset for PeeringRole records.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this BGP Peering Role.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PeeringRoleRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PeeringRole'
+ description: ''
+ patch:
+ operationId: plugins_bgp_peering_roles_partial_update
+ description: REST API viewset for PeeringRole records.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this BGP Peering Role.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PatchedPeeringRoleRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PeeringRole'
+ description: ''
+ delete:
+ operationId: plugins_bgp_peering_roles_destroy
+ description: REST API viewset for PeeringRole records.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this BGP Peering Role.
+ required: true
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ /plugins/bgp/peerings/:
+ get:
+ operationId: plugins_bgp_peerings_list
+ description: REST API viewset for Peering records.
+ 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: 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: 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
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedPeeringList'
+ description: ''
+ post:
+ operationId: plugins_bgp_peerings_create
+ description: REST API viewset for Peering records.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PeeringRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Peering'
+ description: ''
+ put:
+ operationId: plugins_bgp_peerings_bulk_update
+ description: REST API viewset for Peering records.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritablePeeringRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/Peering'
+ description: ''
+ patch:
+ operationId: plugins_bgp_peerings_bulk_partial_update
+ description: REST API viewset for Peering records.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritablePeeringRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/Peering'
+ description: ''
+ delete:
+ operationId: plugins_bgp_peerings_bulk_destroy
+ description: REST API viewset for Peering records.
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /plugins/bgp/peerings/{id}/:
+ get:
+ operationId: plugins_bgp_peerings_retrieve
+ description: REST API viewset for Peering records.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this BGP Peering.
+ required: true
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Peering'
+ description: ''
+ put:
+ operationId: plugins_bgp_peerings_update
+ description: REST API viewset for Peering records.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this BGP Peering.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PeeringRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Peering'
+ description: ''
+ patch:
+ operationId: plugins_bgp_peerings_partial_update
+ description: REST API viewset for Peering records.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this BGP Peering.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PatchedPeeringRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Peering'
+ description: ''
+ delete:
+ operationId: plugins_bgp_peerings_destroy
+ description: REST API viewset for Peering records.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this BGP Peering.
+ required: true
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ /plugins/bgp/routing-instances/:
+ get:
+ operationId: plugins_bgp_routing_instances_list
+ description: REST API viewset for BGPRoutingInstance records.
+ parameters:
+ - in: query
+ name: autonomous_system
+ schema:
+ type: array
+ items:
+ type: integer
+ maximum: 4294967295
+ minimum: 1
+ format: int64
+ description: Autonomous System Number
+ explode: true
+ style: form
+ - in: query
+ name: autonomous_system__n
+ schema:
+ type: array
+ items:
+ type: integer
+ maximum: 4294967295
+ minimum: 1
+ format: int64
+ description: Autonomous System Number
+ 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
+ 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
+ - 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: status
+ 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:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedBGPRoutingInstanceList'
+ description: ''
+ post:
+ operationId: plugins_bgp_routing_instances_create
+ description: REST API viewset for BGPRoutingInstance records.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableBGPRoutingInstanceRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/BGPRoutingInstance'
+ description: ''
+ put:
+ operationId: plugins_bgp_routing_instances_bulk_update
+ description: REST API viewset for BGPRoutingInstance records.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableBGPRoutingInstanceRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BGPRoutingInstance'
+ description: ''
+ patch:
+ operationId: plugins_bgp_routing_instances_bulk_partial_update
+ description: REST API viewset for BGPRoutingInstance records.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableBGPRoutingInstanceRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BGPRoutingInstance'
+ description: ''
+ delete:
+ operationId: plugins_bgp_routing_instances_bulk_destroy
+ description: REST API viewset for BGPRoutingInstance records.
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /plugins/bgp/routing-instances/{id}/:
+ get:
+ operationId: plugins_bgp_routing_instances_retrieve
+ description: REST API viewset for BGPRoutingInstance records.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this BGP Routing Instance.
+ required: true
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/BGPRoutingInstance'
+ description: ''
+ put:
+ operationId: plugins_bgp_routing_instances_update
+ description: REST API viewset for BGPRoutingInstance records.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this BGP Routing Instance.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableBGPRoutingInstanceRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/BGPRoutingInstance'
+ description: ''
+ patch:
+ operationId: plugins_bgp_routing_instances_partial_update
+ description: REST API viewset for BGPRoutingInstance records.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this BGP Routing Instance.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PatchedWritableBGPRoutingInstanceRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/BGPRoutingInstance'
+ description: ''
+ delete:
+ operationId: plugins_bgp_routing_instances_destroy
+ description: REST API viewset for BGPRoutingInstance records.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this BGP Routing Instance.
+ required: true
+ tags:
+ - plugins
+ 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: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: command__ic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: command__ie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: command__iew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: command__ire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: command__isw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: command__n
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: command__nic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: command__nie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: command__niew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: command__nire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: command__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: command__nre
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: command__re
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: grant_type
+ schema:
+ type: string
+ - in: query
+ name: grant_type__n
+ schema:
+ type: string
+ - 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: subcommand
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: subcommand__ic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: subcommand__ie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: subcommand__iew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: subcommand__ire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: subcommand__isw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: subcommand__n
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: subcommand__nic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: subcommand__nie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: subcommand__niew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: subcommand__nire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: subcommand__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: subcommand__nre
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: subcommand__re
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - 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
+ 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/AccessGrantRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableAccessGrantRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableAccessGrantRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/AccessGrantRequest'
+ 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/PatchedAccessGrantRequest'
+ 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: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comment__ic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comment__ie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comment__iew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comment__ire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comment__isw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comment__n
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comment__nic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comment__nie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comment__niew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comment__nire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comment__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comment__nre
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comment__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
+ - 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
+ - in: query
+ name: platform__n
+ 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/CommandTokenRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableCommandTokenRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableCommandTokenRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/CommandTokenRequest'
+ 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/PatchedCommandTokenRequest'
+ 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/CircuitMaintenanceCircuitImpactRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableCircuitMaintenanceCircuitImpactRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableCircuitMaintenanceCircuitImpactRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/CircuitMaintenanceCircuitImpactRequest'
+ 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/PatchedCircuitMaintenanceCircuitImpactRequest'
+ 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
+ - 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: 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/CircuitMaintenanceRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableCircuitMaintenanceRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableCircuitMaintenanceRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/CircuitMaintenanceRequest'
+ 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/PatchedCircuitMaintenanceRequest'
+ 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/NoteRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableNoteRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableNoteRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/NoteRequest'
+ 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/PatchedNoteRequest'
+ 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
+ - 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: 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/MinMaxValidationRuleRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableMinMaxValidationRuleRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableMinMaxValidationRuleRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/MinMaxValidationRuleRequest'
+ 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/PatchedMinMaxValidationRuleRequest'
+ 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/RegularExpressionValidationRuleRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableRegularExpressionValidationRuleRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableRegularExpressionValidationRuleRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/RegularExpressionValidationRuleRequest'
+ 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/PatchedRegularExpressionValidationRuleRequest'
+ 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/OnboardingTaskRequest'
+ 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/firewall/address-object/:
+ get:
+ operationId: plugins_firewall_address_object_list
+ description: AddressObject viewset.
+ 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: fqdn
+ schema:
+ type: string
+ format: uuid
+ - in: query
+ name: fqdn__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: ip_address
+ schema:
+ type: string
+ format: uuid
+ - in: query
+ name: ip_address__n
+ schema:
+ type: string
+ format: uuid
+ - in: query
+ name: ip_range
+ schema:
+ type: string
+ format: uuid
+ - in: query
+ name: ip_range__n
+ schema:
+ type: string
+ format: uuid
+ - 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: prefix
+ schema:
+ type: string
+ format: uuid
+ - in: query
+ name: prefix__n
+ schema:
+ type: string
+ format: uuid
+ - 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
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedAddressObjectList'
+ description: ''
+ post:
+ operationId: plugins_firewall_address_object_create
+ description: AddressObject viewset.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableAddressObjectRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/AddressObject'
+ description: ''
+ put:
+ operationId: plugins_firewall_address_object_bulk_update
+ description: AddressObject viewset.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableAddressObjectRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/AddressObject'
+ description: ''
+ patch:
+ operationId: plugins_firewall_address_object_bulk_partial_update
+ description: AddressObject viewset.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableAddressObjectRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/AddressObject'
+ description: ''
+ delete:
+ operationId: plugins_firewall_address_object_bulk_destroy
+ description: AddressObject viewset.
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /plugins/firewall/address-object-group/:
+ get:
+ operationId: plugins_firewall_address_object_group_list
+ description: AddressObjectGroup viewset.
+ parameters:
+ - in: query
+ name: address_objects
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: address_objects__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ 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: 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
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedAddressObjectGroupList'
+ description: ''
+ post:
+ operationId: plugins_firewall_address_object_group_create
+ description: AddressObjectGroup viewset.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableAddressObjectGroupRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/AddressObjectGroup'
+ description: ''
+ put:
+ operationId: plugins_firewall_address_object_group_bulk_update
+ description: AddressObjectGroup viewset.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableAddressObjectGroupRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/AddressObjectGroup'
+ description: ''
+ patch:
+ operationId: plugins_firewall_address_object_group_bulk_partial_update
+ description: AddressObjectGroup viewset.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableAddressObjectGroupRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/AddressObjectGroup'
+ description: ''
+ delete:
+ operationId: plugins_firewall_address_object_group_bulk_destroy
+ description: AddressObjectGroup viewset.
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /plugins/firewall/address-object-group/{id}/:
+ get:
+ operationId: plugins_firewall_address_object_group_retrieve
+ description: AddressObjectGroup viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this address object group.
+ required: true
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/AddressObjectGroup'
+ description: ''
+ put:
+ operationId: plugins_firewall_address_object_group_update
+ description: AddressObjectGroup viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this address object group.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableAddressObjectGroupRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/AddressObjectGroup'
+ description: ''
+ patch:
+ operationId: plugins_firewall_address_object_group_partial_update
+ description: AddressObjectGroup viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this address object group.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PatchedWritableAddressObjectGroupRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/AddressObjectGroup'
+ description: ''
+ delete:
+ operationId: plugins_firewall_address_object_group_destroy
+ description: AddressObjectGroup viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this address object group.
+ required: true
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ /plugins/firewall/address-object-group/{id}/notes/:
+ get:
+ operationId: plugins_firewall_address_object_group_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this address object group.
+ 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:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: plugins_firewall_address_object_group_notes_create
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this address object group.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /plugins/firewall/address-object/{id}/:
+ get:
+ operationId: plugins_firewall_address_object_retrieve
+ description: AddressObject viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this address object.
+ required: true
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/AddressObject'
+ description: ''
+ put:
+ operationId: plugins_firewall_address_object_update
+ description: AddressObject viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this address object.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableAddressObjectRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/AddressObject'
+ description: ''
+ patch:
+ operationId: plugins_firewall_address_object_partial_update
+ description: AddressObject viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this address object.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PatchedWritableAddressObjectRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/AddressObject'
+ description: ''
+ delete:
+ operationId: plugins_firewall_address_object_destroy
+ description: AddressObject viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this address object.
+ required: true
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ /plugins/firewall/address-object/{id}/notes/:
+ get:
+ operationId: plugins_firewall_address_object_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this address object.
+ 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:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: plugins_firewall_address_object_notes_create
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this address object.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /plugins/firewall/capirca-policy/:
+ get:
+ operationId: plugins_firewall_capirca_policy_list
+ description: CapircaPolicy viewset.
+ 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
+ - 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/PaginatedCapircaPolicyList'
+ description: ''
+ post:
+ operationId: plugins_firewall_capirca_policy_create
+ description: CapircaPolicy viewset.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CapircaPolicyRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/CapircaPolicy'
+ description: ''
+ put:
+ operationId: plugins_firewall_capirca_policy_bulk_update
+ description: CapircaPolicy viewset.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableCapircaPolicyRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/CapircaPolicy'
+ description: ''
+ patch:
+ operationId: plugins_firewall_capirca_policy_bulk_partial_update
+ description: CapircaPolicy viewset.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableCapircaPolicyRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/CapircaPolicy'
+ description: ''
+ delete:
+ operationId: plugins_firewall_capirca_policy_bulk_destroy
+ description: CapircaPolicy viewset.
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /plugins/firewall/capirca-policy/{id}/:
+ get:
+ operationId: plugins_firewall_capirca_policy_retrieve
+ description: CapircaPolicy viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this capirca policy.
+ required: true
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/CapircaPolicy'
+ description: ''
+ put:
+ operationId: plugins_firewall_capirca_policy_update
+ description: CapircaPolicy viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this capirca policy.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CapircaPolicyRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/CapircaPolicy'
+ description: ''
+ patch:
+ operationId: plugins_firewall_capirca_policy_partial_update
+ description: CapircaPolicy viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this capirca policy.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PatchedCapircaPolicyRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/CapircaPolicy'
+ description: ''
+ delete:
+ operationId: plugins_firewall_capirca_policy_destroy
+ description: CapircaPolicy viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this capirca policy.
+ required: true
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ /plugins/firewall/fqdn/:
+ get:
+ operationId: plugins_firewall_fqdn_list
+ description: FQDN viewset.
+ 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: 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
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedFQDNList'
+ description: ''
+ post:
+ operationId: plugins_firewall_fqdn_create
+ description: FQDN viewset.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableFQDNRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/FQDN'
+ description: ''
+ put:
+ operationId: plugins_firewall_fqdn_bulk_update
+ description: FQDN viewset.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableFQDNRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/FQDN'
+ description: ''
+ patch:
+ operationId: plugins_firewall_fqdn_bulk_partial_update
+ description: FQDN viewset.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableFQDNRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/FQDN'
+ description: ''
+ delete:
+ operationId: plugins_firewall_fqdn_bulk_destroy
+ description: FQDN viewset.
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /plugins/firewall/fqdn/{id}/:
+ get:
+ operationId: plugins_firewall_fqdn_retrieve
+ description: FQDN viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this FQDN.
+ required: true
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/FQDN'
+ description: ''
+ put:
+ operationId: plugins_firewall_fqdn_update
+ description: FQDN viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this FQDN.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableFQDNRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/FQDN'
+ description: ''
+ patch:
+ operationId: plugins_firewall_fqdn_partial_update
+ description: FQDN viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this FQDN.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PatchedWritableFQDNRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/FQDN'
+ description: ''
+ delete:
+ operationId: plugins_firewall_fqdn_destroy
+ description: FQDN viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this FQDN.
+ required: true
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ /plugins/firewall/fqdn/{id}/notes/:
+ get:
+ operationId: plugins_firewall_fqdn_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this FQDN.
+ 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:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: plugins_firewall_fqdn_notes_create
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this FQDN.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /plugins/firewall/ip-range/:
+ get:
+ operationId: plugins_firewall_ip_range_list
+ description: IPRange viewset.
+ 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
+ - 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: size
+ schema:
+ type: array
+ items:
+ type: integer
+ explode: true
+ style: form
+ - in: query
+ name: size__gt
+ schema:
+ type: array
+ items:
+ type: integer
+ explode: true
+ style: form
+ - in: query
+ name: size__gte
+ schema:
+ type: array
+ items:
+ type: integer
+ explode: true
+ style: form
+ - in: query
+ name: size__lt
+ schema:
+ type: array
+ items:
+ type: integer
+ explode: true
+ style: form
+ - in: query
+ name: size__lte
+ schema:
+ type: array
+ items:
+ type: integer
+ explode: true
+ style: form
+ - in: query
+ name: size__n
+ schema:
+ type: array
+ items:
+ type: integer
+ explode: true
+ style: form
+ - 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: vrf
+ schema:
+ type: string
+ format: uuid
+ - in: query
+ name: vrf__n
+ schema:
+ type: string
+ format: uuid
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedIPRangeList'
+ description: ''
+ post:
+ operationId: plugins_firewall_ip_range_create
+ description: IPRange viewset.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/IPRangeRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/IPRange'
+ description: ''
+ put:
+ operationId: plugins_firewall_ip_range_bulk_update
+ description: IPRange viewset.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableIPRangeRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/IPRange'
+ description: ''
+ patch:
+ operationId: plugins_firewall_ip_range_bulk_partial_update
+ description: IPRange viewset.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableIPRangeRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/IPRange'
+ description: ''
+ delete:
+ operationId: plugins_firewall_ip_range_bulk_destroy
+ description: IPRange viewset.
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /plugins/firewall/ip-range/{id}/:
+ get:
+ operationId: plugins_firewall_ip_range_retrieve
+ description: IPRange viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this ip range.
+ required: true
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/IPRange'
+ description: ''
+ put:
+ operationId: plugins_firewall_ip_range_update
+ description: IPRange viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this ip range.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/IPRangeRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/IPRange'
+ description: ''
+ patch:
+ operationId: plugins_firewall_ip_range_partial_update
+ description: IPRange viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this ip range.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PatchedIPRangeRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/IPRange'
+ description: ''
+ delete:
+ operationId: plugins_firewall_ip_range_destroy
+ description: IPRange viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this ip range.
+ required: true
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ /plugins/firewall/ip-range/{id}/notes/:
+ get:
+ operationId: plugins_firewall_ip_range_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this ip range.
+ 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:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: plugins_firewall_ip_range_notes_create
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this ip range.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /plugins/firewall/nat-policy/:
+ get:
+ operationId: plugins_firewall_nat_policy_list
+ description: NATPolicy viewset.
+ parameters:
+ - in: query
+ name: assigned_devices
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: assigned_devices__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: assigned_dynamic_groups
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: assigned_dynamic_groups__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ 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
+ - in: query
+ name: nat_policy_rules
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: nat_policy_rules__n
+ 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
+ - 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
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNATPolicyList'
+ description: ''
+ post:
+ operationId: plugins_firewall_nat_policy_create
+ description: NATPolicy viewset.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/NATPolicyRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/NATPolicy'
+ description: ''
+ put:
+ operationId: plugins_firewall_nat_policy_bulk_update
+ description: NATPolicy viewset.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableNATPolicyRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/NATPolicy'
+ description: ''
+ patch:
+ operationId: plugins_firewall_nat_policy_bulk_partial_update
+ description: NATPolicy viewset.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableNATPolicyRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/NATPolicy'
+ description: ''
+ delete:
+ operationId: plugins_firewall_nat_policy_bulk_destroy
+ description: NATPolicy viewset.
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /plugins/firewall/nat-policy-rule/:
+ get:
+ operationId: plugins_firewall_nat_policy_rule_list
+ description: NATPolicyRule viewset.
+ 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: log
+ 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: remark
+ schema:
+ type: boolean
+ - in: query
+ name: request_id
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: request_id__ic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: request_id__ie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: request_id__iew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: request_id__ire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: request_id__isw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: request_id__n
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: request_id__nic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: request_id__nie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: request_id__niew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: request_id__nire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: request_id__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: request_id__nre
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: request_id__re
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - 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: 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:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNATPolicyRuleList'
+ description: ''
+ post:
+ operationId: plugins_firewall_nat_policy_rule_create
+ description: NATPolicyRule viewset.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableNATPolicyRuleRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/NATPolicyRule'
+ description: ''
+ put:
+ operationId: plugins_firewall_nat_policy_rule_bulk_update
+ description: NATPolicyRule viewset.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableNATPolicyRuleRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/NATPolicyRule'
+ description: ''
+ patch:
+ operationId: plugins_firewall_nat_policy_rule_bulk_partial_update
+ description: NATPolicyRule viewset.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableNATPolicyRuleRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/NATPolicyRule'
+ description: ''
+ delete:
+ operationId: plugins_firewall_nat_policy_rule_bulk_destroy
+ description: NATPolicyRule viewset.
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /plugins/firewall/nat-policy-rule/{id}/:
+ get:
+ operationId: plugins_firewall_nat_policy_rule_retrieve
+ description: NATPolicyRule viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this nat policy rule.
+ required: true
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/NATPolicyRule'
+ description: ''
+ put:
+ operationId: plugins_firewall_nat_policy_rule_update
+ description: NATPolicyRule viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this nat policy rule.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableNATPolicyRuleRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/NATPolicyRule'
+ description: ''
+ patch:
+ operationId: plugins_firewall_nat_policy_rule_partial_update
+ description: NATPolicyRule viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this nat policy rule.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PatchedWritableNATPolicyRuleRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/NATPolicyRule'
+ description: ''
+ delete:
+ operationId: plugins_firewall_nat_policy_rule_destroy
+ description: NATPolicyRule viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this nat policy rule.
+ required: true
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ /plugins/firewall/nat-policy-rule/{id}/notes/:
+ get:
+ operationId: plugins_firewall_nat_policy_rule_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this nat policy rule.
+ 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:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: plugins_firewall_nat_policy_rule_notes_create
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this nat policy rule.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /plugins/firewall/nat-policy/{id}/:
+ get:
+ operationId: plugins_firewall_nat_policy_retrieve
+ description: NATPolicy viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this nat policy.
+ required: true
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/NATPolicy'
+ description: ''
+ put:
+ operationId: plugins_firewall_nat_policy_update
+ description: NATPolicy viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this nat policy.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/NATPolicyRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/NATPolicy'
+ description: ''
+ patch:
+ operationId: plugins_firewall_nat_policy_partial_update
+ description: NATPolicy viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this nat policy.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PatchedNATPolicyRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/NATPolicy'
+ description: ''
+ delete:
+ operationId: plugins_firewall_nat_policy_destroy
+ description: NATPolicy viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this nat policy.
+ required: true
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ /plugins/firewall/nat-policy/{id}/notes/:
+ get:
+ operationId: plugins_firewall_nat_policy_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this nat policy.
+ 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:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: plugins_firewall_nat_policy_notes_create
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this nat policy.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /plugins/firewall/policy/:
+ get:
+ operationId: plugins_firewall_policy_list
+ description: Policy viewset.
+ parameters:
+ - in: query
+ name: assigned_devices
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: assigned_devices__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: assigned_dynamic_groups
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: assigned_dynamic_groups__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ 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: policy_rules
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: policy_rules__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - 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
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedPolicyList'
+ description: ''
+ post:
+ operationId: plugins_firewall_policy_create
+ description: Policy viewset.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PolicyRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Policy'
+ description: ''
+ put:
+ operationId: plugins_firewall_policy_bulk_update
+ description: Policy viewset.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritablePolicyRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/Policy'
+ description: ''
+ patch:
+ operationId: plugins_firewall_policy_bulk_partial_update
+ description: Policy viewset.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritablePolicyRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/Policy'
+ description: ''
+ delete:
+ operationId: plugins_firewall_policy_bulk_destroy
+ description: Policy viewset.
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /plugins/firewall/policy-rule/:
+ get:
+ operationId: plugins_firewall_policy_rule_list
+ description: PolicyRule viewset.
+ parameters:
+ - in: query
+ name: action
+ schema:
+ type: string
+ enum:
+ - allow
+ - deny
+ - drop
+ - remark
+ - in: query
+ name: action__n
+ schema:
+ type: string
+ enum:
+ - allow
+ - deny
+ - drop
+ - remark
+ - 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: log
+ 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: request_id
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: request_id__ic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: request_id__ie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: request_id__iew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: request_id__ire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: request_id__isw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: request_id__n
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: request_id__nic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: request_id__nie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: request_id__niew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: request_id__nire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: request_id__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: request_id__nre
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: request_id__re
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - 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: 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:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedPolicyRuleList'
+ description: ''
+ post:
+ operationId: plugins_firewall_policy_rule_create
+ description: PolicyRule viewset.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritablePolicyRuleRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PolicyRule'
+ description: ''
+ put:
+ operationId: plugins_firewall_policy_rule_bulk_update
+ description: PolicyRule viewset.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritablePolicyRuleRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PolicyRule'
+ description: ''
+ patch:
+ operationId: plugins_firewall_policy_rule_bulk_partial_update
+ description: PolicyRule viewset.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritablePolicyRuleRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PolicyRule'
+ description: ''
+ delete:
+ operationId: plugins_firewall_policy_rule_bulk_destroy
+ description: PolicyRule viewset.
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /plugins/firewall/policy-rule/{id}/:
+ get:
+ operationId: plugins_firewall_policy_rule_retrieve
+ description: PolicyRule viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this policy rule.
+ required: true
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PolicyRule'
+ description: ''
+ put:
+ operationId: plugins_firewall_policy_rule_update
+ description: PolicyRule viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this policy rule.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritablePolicyRuleRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PolicyRule'
+ description: ''
+ patch:
+ operationId: plugins_firewall_policy_rule_partial_update
+ description: PolicyRule viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this policy rule.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PatchedWritablePolicyRuleRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PolicyRule'
+ description: ''
+ delete:
+ operationId: plugins_firewall_policy_rule_destroy
+ description: PolicyRule viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this policy rule.
+ required: true
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ /plugins/firewall/policy-rule/{id}/notes/:
+ get:
+ operationId: plugins_firewall_policy_rule_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this policy rule.
+ 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:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: plugins_firewall_policy_rule_notes_create
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this policy rule.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /plugins/firewall/policy/{id}/:
+ get:
+ operationId: plugins_firewall_policy_retrieve
+ description: Policy viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this policy.
+ required: true
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Policy'
+ description: ''
+ put:
+ operationId: plugins_firewall_policy_update
+ description: Policy viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this policy.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PolicyRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Policy'
+ description: ''
+ patch:
+ operationId: plugins_firewall_policy_partial_update
+ description: Policy viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this policy.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PatchedPolicyRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Policy'
+ description: ''
+ delete:
+ operationId: plugins_firewall_policy_destroy
+ description: Policy viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this policy.
+ required: true
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ /plugins/firewall/policy/{id}/notes/:
+ get:
+ operationId: plugins_firewall_policy_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this policy.
+ 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:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: plugins_firewall_policy_notes_create
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this policy.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /plugins/firewall/service-object/:
+ get:
+ operationId: plugins_firewall_service_object_list
+ description: ServiceObject viewset.
+ 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: ip_protocol
+ schema:
+ type: string
+ enum:
+ - 3PC
+ - A/N
+ - AH
+ - ARIS
+ - AX.25
+ - BBN-RCC-MON
+ - BNA
+ - BR-SAT-MON
+ - CBT
+ - CFTP
+ - CHAOS
+ - CPHB
+ - CPNX
+ - CRTP
+ - CRUDP
+ - Compaq-Peer
+ - DCCP
+ - DCN-MEAS
+ - DDP
+ - DDX
+ - DGP
+ - DSR
+ - EGP
+ - EIGRP
+ - EMCON
+ - ENCAP
+ - ESP
+ - ETHERIP
+ - Ethernet
+ - FC
+ - FIRE
+ - GGP
+ - GMTP
+ - GRE
+ - HIP
+ - HMP
+ - I-NLSP
+ - IATP
+ - ICMP
+ - IDPR
+ - IDPR-CMTP
+ - IDRP
+ - IFMP
+ - IGMP
+ - IGP
+ - IL
+ - IPCV
+ - IPComp
+ - IPIP
+ - IPLT
+ - IPPC
+ - IPX-in-IP
+ - IRTP
+ - ISO-IP
+ - ISO-TP4
+ - KRYPTOLAN
+ - L2TP
+ - LARP
+ - LEAF-1
+ - LEAF-2
+ - MERIT-INP
+ - MFE-NSP
+ - MOBILE
+ - MTP
+ - MUX
+ - NARP
+ - NETBLT
+ - NSFNET-IGP
+ - NVP-II
+ - OSPFIGP
+ - PGM
+ - PIM
+ - PIPE
+ - PNNI
+ - PRM
+ - PTP
+ - PUP
+ - PVP
+ - QNX
+ - RDP
+ - ROHC
+ - RSVP
+ - RSVP-E2E-IGNORE
+ - RVD
+ - SAT-EXPAK
+ - SAT-MON
+ - SCC-SP
+ - SCPS
+ - SCTP
+ - SDRP
+ - SECURE-VMTP
+ - SKIP
+ - SM
+ - SMP
+ - SNP
+ - SPS
+ - SRP
+ - SSCOPMCE
+ - STP
+ - SUN-ND
+ - Sprite-RPC
+ - TCF
+ - TCP
+ - TLSP
+ - TP++
+ - TRUNK-1
+ - TRUNK-2
+ - TTP
+ - UDP
+ - UDPLite
+ - UTI
+ - VINES
+ - VISA
+ - VMTP
+ - WB-EXPAK
+ - WB-MON
+ - WESP
+ - WSN
+ - XNET
+ - XNS-IDP
+ - XTP
+ - manet
+ description: IANA IP Protocol (e.g. TCP UDP ICMP)
+ - in: query
+ name: ip_protocol__n
+ schema:
+ type: string
+ enum:
+ - 3PC
+ - A/N
+ - AH
+ - ARIS
+ - AX.25
+ - BBN-RCC-MON
+ - BNA
+ - BR-SAT-MON
+ - CBT
+ - CFTP
+ - CHAOS
+ - CPHB
+ - CPNX
+ - CRTP
+ - CRUDP
+ - Compaq-Peer
+ - DCCP
+ - DCN-MEAS
+ - DDP
+ - DDX
+ - DGP
+ - DSR
+ - EGP
+ - EIGRP
+ - EMCON
+ - ENCAP
+ - ESP
+ - ETHERIP
+ - Ethernet
+ - FC
+ - FIRE
+ - GGP
+ - GMTP
+ - GRE
+ - HIP
+ - HMP
+ - I-NLSP
+ - IATP
+ - ICMP
+ - IDPR
+ - IDPR-CMTP
+ - IDRP
+ - IFMP
+ - IGMP
+ - IGP
+ - IL
+ - IPCV
+ - IPComp
+ - IPIP
+ - IPLT
+ - IPPC
+ - IPX-in-IP
+ - IRTP
+ - ISO-IP
+ - ISO-TP4
+ - KRYPTOLAN
+ - L2TP
+ - LARP
+ - LEAF-1
+ - LEAF-2
+ - MERIT-INP
+ - MFE-NSP
+ - MOBILE
+ - MTP
+ - MUX
+ - NARP
+ - NETBLT
+ - NSFNET-IGP
+ - NVP-II
+ - OSPFIGP
+ - PGM
+ - PIM
+ - PIPE
+ - PNNI
+ - PRM
+ - PTP
+ - PUP
+ - PVP
+ - QNX
+ - RDP
+ - ROHC
+ - RSVP
+ - RSVP-E2E-IGNORE
+ - RVD
+ - SAT-EXPAK
+ - SAT-MON
+ - SCC-SP
+ - SCPS
+ - SCTP
+ - SDRP
+ - SECURE-VMTP
+ - SKIP
+ - SM
+ - SMP
+ - SNP
+ - SPS
+ - SRP
+ - SSCOPMCE
+ - STP
+ - SUN-ND
+ - Sprite-RPC
+ - TCF
+ - TCP
+ - TLSP
+ - TP++
+ - TRUNK-1
+ - TRUNK-2
+ - TTP
+ - UDP
+ - UDPLite
+ - UTI
+ - VINES
+ - VISA
+ - VMTP
+ - WB-EXPAK
+ - WB-MON
+ - WESP
+ - WSN
+ - XNET
+ - XNS-IDP
+ - XTP
+ - manet
+ description: IANA IP Protocol (e.g. TCP UDP ICMP)
+ - 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: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: port__ic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: port__ie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: port__iew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: port__ire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: port__isw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: port__n
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: port__nic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: port__nie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: port__niew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: port__nire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: port__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: port__nre
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: port__re
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - 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
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedServiceObjectList'
+ description: ''
+ post:
+ operationId: plugins_firewall_service_object_create
+ description: ServiceObject viewset.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ServiceObjectRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/ServiceObject'
+ description: ''
+ put:
+ operationId: plugins_firewall_service_object_bulk_update
+ description: ServiceObject viewset.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableServiceObjectRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/ServiceObject'
+ description: ''
+ patch:
+ operationId: plugins_firewall_service_object_bulk_partial_update
+ description: ServiceObject viewset.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableServiceObjectRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/ServiceObject'
+ description: ''
+ delete:
+ operationId: plugins_firewall_service_object_bulk_destroy
+ description: ServiceObject viewset.
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /plugins/firewall/service-object-group/:
+ get:
+ operationId: plugins_firewall_service_object_group_list
+ description: ServiceObjectGroup viewset.
+ 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: service_objects
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: service_objects__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - 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
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedServiceObjectGroupList'
+ description: ''
+ post:
+ operationId: plugins_firewall_service_object_group_create
+ description: ServiceObjectGroup viewset.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableServiceObjectGroupRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/ServiceObjectGroup'
+ description: ''
+ put:
+ operationId: plugins_firewall_service_object_group_bulk_update
+ description: ServiceObjectGroup viewset.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableServiceObjectGroupRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/ServiceObjectGroup'
+ description: ''
+ patch:
+ operationId: plugins_firewall_service_object_group_bulk_partial_update
+ description: ServiceObjectGroup viewset.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableServiceObjectGroupRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/ServiceObjectGroup'
+ description: ''
+ delete:
+ operationId: plugins_firewall_service_object_group_bulk_destroy
+ description: ServiceObjectGroup viewset.
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /plugins/firewall/service-object-group/{id}/:
+ get:
+ operationId: plugins_firewall_service_object_group_retrieve
+ description: ServiceObjectGroup viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this service object group.
+ required: true
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/ServiceObjectGroup'
+ description: ''
+ put:
+ operationId: plugins_firewall_service_object_group_update
+ description: ServiceObjectGroup viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this service object group.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableServiceObjectGroupRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/ServiceObjectGroup'
+ description: ''
+ patch:
+ operationId: plugins_firewall_service_object_group_partial_update
+ description: ServiceObjectGroup viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this service object group.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PatchedWritableServiceObjectGroupRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/ServiceObjectGroup'
+ description: ''
+ delete:
+ operationId: plugins_firewall_service_object_group_destroy
+ description: ServiceObjectGroup viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this service object group.
+ required: true
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ /plugins/firewall/service-object-group/{id}/notes/:
+ get:
+ operationId: plugins_firewall_service_object_group_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this service object group.
+ 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:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: plugins_firewall_service_object_group_notes_create
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this service object group.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /plugins/firewall/service-object/{id}/:
+ get:
+ operationId: plugins_firewall_service_object_retrieve
+ description: ServiceObject viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this service object.
+ required: true
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/ServiceObject'
+ description: ''
+ put:
+ operationId: plugins_firewall_service_object_update
+ description: ServiceObject viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this service object.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ServiceObjectRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/ServiceObject'
+ description: ''
+ patch:
+ operationId: plugins_firewall_service_object_partial_update
+ description: ServiceObject viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this service object.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PatchedServiceObjectRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/ServiceObject'
+ description: ''
+ delete:
+ operationId: plugins_firewall_service_object_destroy
+ description: ServiceObject viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this service object.
+ required: true
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ /plugins/firewall/service-object/{id}/notes/:
+ get:
+ operationId: plugins_firewall_service_object_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this service object.
+ 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:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: plugins_firewall_service_object_notes_create
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this service object.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /plugins/firewall/user-object/:
+ get:
+ operationId: plugins_firewall_user_object_list
+ description: UserObject viewset.
+ 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: 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: 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:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedUserObjectList'
+ description: ''
+ post:
+ operationId: plugins_firewall_user_object_create
+ description: UserObject viewset.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UserObjectRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/UserObject'
+ description: ''
+ put:
+ operationId: plugins_firewall_user_object_bulk_update
+ description: UserObject viewset.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableUserObjectRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/UserObject'
+ description: ''
+ patch:
+ operationId: plugins_firewall_user_object_bulk_partial_update
+ description: UserObject viewset.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableUserObjectRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/UserObject'
+ description: ''
+ delete:
+ operationId: plugins_firewall_user_object_bulk_destroy
+ description: UserObject viewset.
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /plugins/firewall/user-object-group/:
+ get:
+ operationId: plugins_firewall_user_object_group_list
+ description: UserObjectGroup viewset.
+ 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: 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_objects
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: user_objects__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedUserObjectGroupList'
+ description: ''
+ post:
+ operationId: plugins_firewall_user_object_group_create
+ description: UserObjectGroup viewset.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableUserObjectGroupRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/UserObjectGroup'
+ description: ''
+ put:
+ operationId: plugins_firewall_user_object_group_bulk_update
+ description: UserObjectGroup viewset.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableUserObjectGroupRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/UserObjectGroup'
+ description: ''
+ patch:
+ operationId: plugins_firewall_user_object_group_bulk_partial_update
+ description: UserObjectGroup viewset.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableUserObjectGroupRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/UserObjectGroup'
+ description: ''
+ delete:
+ operationId: plugins_firewall_user_object_group_bulk_destroy
+ description: UserObjectGroup viewset.
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /plugins/firewall/user-object-group/{id}/:
+ get:
+ operationId: plugins_firewall_user_object_group_retrieve
+ description: UserObjectGroup viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this user object group.
+ required: true
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/UserObjectGroup'
+ description: ''
+ put:
+ operationId: plugins_firewall_user_object_group_update
+ description: UserObjectGroup viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this user object group.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableUserObjectGroupRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/UserObjectGroup'
+ description: ''
+ patch:
+ operationId: plugins_firewall_user_object_group_partial_update
+ description: UserObjectGroup viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this user object group.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PatchedWritableUserObjectGroupRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/UserObjectGroup'
+ description: ''
+ delete:
+ operationId: plugins_firewall_user_object_group_destroy
+ description: UserObjectGroup viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this user object group.
+ required: true
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ /plugins/firewall/user-object-group/{id}/notes/:
+ get:
+ operationId: plugins_firewall_user_object_group_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this user object group.
+ 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:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: plugins_firewall_user_object_group_notes_create
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this user object group.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /plugins/firewall/user-object/{id}/:
+ get:
+ operationId: plugins_firewall_user_object_retrieve
+ description: UserObject viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this user object.
+ required: true
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/UserObject'
+ description: ''
+ put:
+ operationId: plugins_firewall_user_object_update
+ description: UserObject viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this user object.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UserObjectRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/UserObject'
+ description: ''
+ patch:
+ operationId: plugins_firewall_user_object_partial_update
+ description: UserObject viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this user object.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PatchedUserObjectRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/UserObject'
+ description: ''
+ delete:
+ operationId: plugins_firewall_user_object_destroy
+ description: UserObject viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this user object.
+ required: true
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ /plugins/firewall/user-object/{id}/notes/:
+ get:
+ operationId: plugins_firewall_user_object_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this user object.
+ 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:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: plugins_firewall_user_object_notes_create
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this user object.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /plugins/firewall/zone/:
+ get:
+ operationId: plugins_firewall_zone_list
+ description: Zone viewset.
+ 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: interfaces
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: interfaces__n
+ 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: 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: vrfs
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: vrfs__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedZoneList'
+ description: ''
+ post:
+ operationId: plugins_firewall_zone_create
+ description: Zone viewset.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ZoneRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Zone'
+ description: ''
+ put:
+ operationId: plugins_firewall_zone_bulk_update
+ description: Zone viewset.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableZoneRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/Zone'
+ description: ''
+ patch:
+ operationId: plugins_firewall_zone_bulk_partial_update
+ description: Zone viewset.
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableZoneRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/Zone'
+ description: ''
+ delete:
+ operationId: plugins_firewall_zone_bulk_destroy
+ description: Zone viewset.
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /plugins/firewall/zone/{id}/:
+ get:
+ operationId: plugins_firewall_zone_retrieve
+ description: Zone viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this zone.
+ required: true
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Zone'
+ description: ''
+ put:
+ operationId: plugins_firewall_zone_update
+ description: Zone viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this zone.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ZoneRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Zone'
+ description: ''
+ patch:
+ operationId: plugins_firewall_zone_partial_update
+ description: Zone viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this zone.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PatchedZoneRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Zone'
+ description: ''
+ delete:
+ operationId: plugins_firewall_zone_destroy
+ description: Zone viewset.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this zone.
+ required: true
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ /plugins/firewall/zone/{id}/notes/:
+ get:
+ operationId: plugins_firewall_zone_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this zone.
+ 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:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: plugins_firewall_zone_notes_create
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this zone.
+ required: true
+ tags:
+ - plugins
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /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
+ - in: query
+ name: slug
+ schema:
+ type: string
+ 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/ComplianceFeatureRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableComplianceFeatureRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableComplianceFeatureRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/ComplianceFeatureRequest'
+ 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/PatchedComplianceFeatureRequest'
+ 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/ComplianceRuleRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableComplianceRuleRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableComplianceRuleRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/ComplianceRuleRequest'
+ 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/PatchedComplianceRuleRequest'
+ 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/ConfigComplianceRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableConfigComplianceRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableConfigComplianceRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/ConfigComplianceRequest'
+ 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/PatchedConfigComplianceRequest'
+ 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-postprocessing/{id}/:
+ get:
+ operationId: plugins_golden_config_config_postprocessing_retrieve
+ description: Detail REST API view showing configuration after postprocessing.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this device.
+ required: true
+ tags:
+ - plugins
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/ConfigToPush'
+ description: ''
+ /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/ConfigRemoveRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableConfigRemoveRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableConfigRemoveRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/ConfigRemoveRequest'
+ 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/PatchedConfigRemoveRequest'
+ 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/ConfigReplaceRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableConfigReplaceRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableConfigReplaceRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/ConfigReplaceRequest'
+ 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/PatchedConfigReplaceRequest'
+ 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/GoldenConfigRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableGoldenConfigRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableGoldenConfigRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /plugins/golden-config/golden-config-settings/:
+ get:
+ operationId: plugins_golden_config_golden_config_settings_list
+ description: API viewset for interacting with GoldenConfigSetting objects.
+ parameters:
+ - in: query
+ name: backup_repository
+ schema:
+ type: string
+ format: uuid
+ - in: query
+ name: backup_repository__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: intended_repository
+ schema:
+ type: string
+ format: uuid
+ - in: query
+ name: intended_repository__n
+ schema:
+ type: string
+ format: uuid
+ - in: query
+ name: jinja_repository
+ schema:
+ type: string
+ format: uuid
+ - in: query
+ name: jinja_repository__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: 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: 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:
+ - 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/WritableGoldenConfigSettingRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableGoldenConfigSettingRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableGoldenConfigSettingRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/WritableGoldenConfigSettingRequest'
+ 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/PatchedWritableGoldenConfigSettingRequest'
+ 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/GoldenConfigRequest'
+ 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/PatchedGoldenConfigRequest'
+ 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: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: address__ic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: address__ie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: address__iew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: address__ire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: address__isw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: address__n
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: address__nic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: address__nie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: address__niew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: address__nire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: address__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: address__nre
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: address__re
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__ic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__ie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__iew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__ire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__isw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__n
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__nic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__nie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__niew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__nire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__nre
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__re
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: contract
+ schema:
+ type: string
+ format: uuid
+ - in: query
+ name: contract__n
+ schema:
+ type: string
+ format: uuid
+ - 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: 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: 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: phone
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: phone__ic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: phone__ie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: phone__iew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: phone__ire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: phone__isw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: phone__n
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: phone__nic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: phone__nie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: phone__niew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: phone__nire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: phone__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: phone__nre
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: phone__re
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: priority
+ schema:
+ type: array
+ items:
+ type: integer
+ explode: true
+ style: form
+ - in: query
+ name: priority__gt
+ schema:
+ type: array
+ items:
+ type: integer
+ explode: true
+ style: form
+ - in: query
+ name: priority__gte
+ schema:
+ type: array
+ items:
+ type: integer
+ explode: true
+ style: form
+ - in: query
+ name: priority__lt
+ schema:
+ type: array
+ items:
+ type: integer
+ explode: true
+ style: form
+ - in: query
+ name: priority__lte
+ schema:
+ type: array
+ items:
+ type: integer
+ explode: true
+ style: form
+ - in: query
+ name: priority__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: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: type__ic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: type__ie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: type__iew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: type__ire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: type__isw
+ 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: type__nic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: type__nie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: type__niew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: type__nire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: type__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: type__nre
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: type__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/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/WritableContactLCMRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableContactLCMRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableContactLCMRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/WritableContactLCMRequest'
+ 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/PatchedWritableContactLCMRequest'
+ 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: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: contract_type__ic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: contract_type__ie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: contract_type__iew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: contract_type__ire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: contract_type__isw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: contract_type__n
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: contract_type__nic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: contract_type__nie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: contract_type__niew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: contract_type__nire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: contract_type__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: contract_type__nre
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: contract_type__re
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: cost
+ schema:
+ type: array
+ items:
+ type: number
+ explode: true
+ style: form
+ - in: query
+ name: cost__gt
+ schema:
+ type: array
+ items:
+ type: number
+ explode: true
+ style: form
+ - in: query
+ name: cost__gte
+ schema:
+ type: array
+ items:
+ type: number
+ explode: true
+ style: form
+ - in: query
+ name: cost__lt
+ schema:
+ type: array
+ items:
+ type: number
+ explode: true
+ style: form
+ - in: query
+ name: cost__lte
+ schema:
+ type: array
+ items:
+ type: number
+ explode: true
+ style: form
+ - in: query
+ name: cost__n
+ schema:
+ type: array
+ items:
+ type: number
+ 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: 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
+ - 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
+ format: uuid
+ description: Provider
+ explode: true
+ style: form
+ - in: query
+ name: provider__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ 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: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: support_level__ic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: support_level__ie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: support_level__iew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: support_level__ire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: support_level__isw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: support_level__n
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: support_level__nic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: support_level__nie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: support_level__niew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: support_level__nire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: support_level__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: support_level__nre
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: support_level__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/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/WritableContractLCMRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableContractLCMRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableContractLCMRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/WritableContractLCMRequest'
+ 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/PatchedWritableContractLCMRequest'
+ 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: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__ic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__ie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__iew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__ire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__isw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__n
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__nic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__nie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__niew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__nire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__nre
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__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: cvss
+ schema:
+ type: array
+ items:
+ type: number
+ format: float
+ explode: true
+ style: form
+ - in: query
+ name: cvss__gt
+ schema:
+ type: array
+ items:
+ type: number
+ format: float
+ explode: true
+ style: form
+ - in: query
+ name: cvss__gte
+ schema:
+ type: array
+ items:
+ type: number
+ format: float
+ explode: true
+ style: form
+ - in: query
+ name: cvss__lt
+ schema:
+ type: array
+ items:
+ type: number
+ format: float
+ explode: true
+ style: form
+ - in: query
+ name: cvss__lte
+ schema:
+ type: array
+ items:
+ type: number
+ format: float
+ explode: true
+ style: form
+ - in: query
+ name: cvss__n
+ schema:
+ type: array
+ items:
+ type: number
+ format: float
+ explode: true
+ style: form
+ - in: query
+ name: cvss_v2
+ schema:
+ type: array
+ items:
+ type: number
+ format: float
+ explode: true
+ style: form
+ - in: query
+ name: cvss_v2__gt
+ schema:
+ type: array
+ items:
+ type: number
+ format: float
+ explode: true
+ style: form
+ - in: query
+ name: cvss_v2__gte
+ schema:
+ type: array
+ items:
+ type: number
+ format: float
+ explode: true
+ style: form
+ - in: query
+ name: cvss_v2__lt
+ schema:
+ type: array
+ items:
+ type: number
+ format: float
+ explode: true
+ style: form
+ - in: query
+ name: cvss_v2__lte
+ schema:
+ type: array
+ items:
+ type: number
+ format: float
+ explode: true
+ style: form
+ - in: query
+ name: cvss_v2__n
+ schema:
+ type: array
+ items:
+ type: number
+ format: float
+ explode: true
+ style: form
+ - in: query
+ name: cvss_v3
+ schema:
+ type: array
+ items:
+ type: number
+ format: float
+ explode: true
+ style: form
+ - in: query
+ name: cvss_v3__gt
+ schema:
+ type: array
+ items:
+ type: number
+ format: float
+ explode: true
+ style: form
+ - in: query
+ name: cvss_v3__gte
+ schema:
+ type: array
+ items:
+ type: number
+ format: float
+ explode: true
+ style: form
+ - in: query
+ name: cvss_v3__lt
+ schema:
+ type: array
+ items:
+ type: number
+ format: float
+ explode: true
+ style: form
+ - in: query
+ name: cvss_v3__lte
+ schema:
+ type: array
+ items:
+ type: number
+ format: float
+ explode: true
+ style: form
+ - in: query
+ name: cvss_v3__n
+ schema:
+ type: array
+ items:
+ type: number
+ format: float
+ explode: true
+ style: form
+ - 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: exclude_status
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: exclude_status__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ explode: true
+ style: form
+ - in: query
+ name: fix
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: fix__ic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: fix__ie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: fix__iew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: fix__ire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: fix__isw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: fix__n
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: fix__nic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: fix__nie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: fix__niew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: fix__nire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: fix__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: fix__nre
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: fix__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: link
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: link__ic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: link__ie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: link__iew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: link__ire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: link__isw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: link__n
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: link__nic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: link__nie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: link__niew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: link__nire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: link__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: link__nre
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: link__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
+ - 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: severity__n
+ schema:
+ type: string
+ - 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
+ 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/WritableCVELCMRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableCVELCMRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableCVELCMRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/WritableCVELCMRequest'
+ 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/PatchedWritableCVELCMRequest'
+ 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: 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_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: 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: 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: inventory_item
+ schema:
+ type: array
+ items:
+ type: string
+ nullable: true
+ title: Inventory Item Part
+ description: Inventory Part ID
+ explode: true
+ style: form
+ - in: query
+ name: inventory_item__n
+ schema:
+ type: array
+ items:
+ type: string
+ nullable: true
+ title: Inventory Item Part
+ description: Inventory Part 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
+ - 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/WritableHardwareLCMRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableHardwareLCMRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableHardwareLCMRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/WritableHardwareLCMRequest'
+ 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/PatchedWritableHardwareLCMRequest'
+ 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: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__ic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__ie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__iew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__ire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__isw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__n
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__nic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__nie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__niew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__nire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__nre
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__re
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: country
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: country__ic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: country__ie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: country__iew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: country__ire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: country__isw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: country__n
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: country__nic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: country__nie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: country__niew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: country__nire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: country__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: country__nre
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: country__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: 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: 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: 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: phone
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: phone__ic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: phone__ie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: phone__iew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: phone__ire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: phone__isw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: phone__n
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: phone__nic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: phone__nie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: phone__niew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: phone__nire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: phone__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: phone__nre
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: phone__re
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: physical_address
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: physical_address__ic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: physical_address__ie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: physical_address__iew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: physical_address__ire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: physical_address__isw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: physical_address__n
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: physical_address__nic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: physical_address__nie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: physical_address__niew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: physical_address__nire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: physical_address__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: physical_address__nre
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: physical_address__re
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: portal_url
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: portal_url__ic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: portal_url__ie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: portal_url__iew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: portal_url__ire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: portal_url__isw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: portal_url__n
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: portal_url__nic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: portal_url__nie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: portal_url__niew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: portal_url__nire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: portal_url__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: portal_url__nre
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: portal_url__re
+ schema:
+ type: array
+ items:
+ type: string
+ 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/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/ProviderLCMRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableProviderLCMRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableProviderLCMRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/ProviderLCMRequest'
+ 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/PatchedProviderLCMRequest'
+ 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: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: alias__ic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: alias__ie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: alias__iew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: alias__ire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: alias__isw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: alias__n
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: alias__nic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: alias__nie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: alias__niew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: alias__nire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: alias__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: alias__nre
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: alias__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: device_platform
+ schema:
+ type: array
+ items:
+ type: string
+ description: Device Platform (Slug)
+ explode: true
+ style: form
+ - in: query
+ name: device_platform__n
+ 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
+ - 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: 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: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: version__ic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: version__ie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: version__iew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: version__ire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: version__isw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: version__n
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: version__nic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: version__nie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: version__niew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: version__nire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: version__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: version__nre
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: version__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/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/WritableSoftwareLCMRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableSoftwareLCMRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableSoftwareLCMRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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: 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: 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__n
+ 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: device_types_id__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Device Types
+ explode: true
+ style: form
+ - in: query
+ name: download_url
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: download_url__ic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: download_url__ie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: download_url__iew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: download_url__ire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: download_url__isw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: download_url__n
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: download_url__nic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: download_url__nie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: download_url__niew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: download_url__nire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: download_url__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: download_url__nre
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: download_url__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: image_file_checksum
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: image_file_checksum__ic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: image_file_checksum__ie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: image_file_checksum__iew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: image_file_checksum__ire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: image_file_checksum__isw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: image_file_checksum__n
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: image_file_checksum__nic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: image_file_checksum__nie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: image_file_checksum__niew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: image_file_checksum__nire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: image_file_checksum__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: image_file_checksum__nre
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: image_file_checksum__re
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: image_file_name
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: image_file_name__ic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: image_file_name__ie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: image_file_name__iew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: image_file_name__ire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: image_file_name__isw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: image_file_name__n
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: image_file_name__nic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: image_file_name__nie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: image_file_name__niew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: image_file_name__nire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: image_file_name__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: image_file_name__nre
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: image_file_name__re
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - 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__n
+ 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
+ - in: query
+ name: inventory_items_id__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Inventory Items
+ 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: object_tags
+ schema:
+ type: array
+ items:
+ type: string
+ description: Object Tags (slug)
+ explode: true
+ style: form
+ - in: query
+ name: object_tags__n
+ 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
+ - in: query
+ name: object_tags_id__n
+ 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__n
+ 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
+ - in: query
+ name: software_version__n
+ 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/WritableSoftwareImageLCMRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableSoftwareImageLCMRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableSoftwareImageLCMRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/WritableSoftwareImageLCMRequest'
+ 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/PatchedWritableSoftwareImageLCMRequest'
+ 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/WritableSoftwareLCMRequest'
+ 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/PatchedWritableSoftwareLCMRequest'
+ 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: 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_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__n
+ 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_roles_id__n
+ 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__n
+ 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: device_types_id__n
+ 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__n
+ 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: devices_id__n
+ 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: 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: 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__n
+ 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
+ - in: query
+ name: inventory_items_id__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Inventory Items
+ 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: object_tags
+ schema:
+ type: array
+ items:
+ type: string
+ description: Object Tags (slug)
+ explode: true
+ style: form
+ - in: query
+ name: object_tags__n
+ 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
+ - in: query
+ name: object_tags_id__n
+ 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: software__n
+ 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/WritableValidatedSoftwareLCMRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableValidatedSoftwareLCMRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableValidatedSoftwareLCMRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/WritableValidatedSoftwareLCMRequest'
+ 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/PatchedWritableValidatedSoftwareLCMRequest'
+ 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: 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: cve
+ schema:
+ type: string
+ format: uuid
+ - in: query
+ name: cve__n
+ 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: device__n
+ 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: exclude_status__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ 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: inventory_item
+ schema:
+ type: string
+ format: uuid
+ - in: query
+ name: inventory_item__n
+ schema:
+ type: string
+ format: uuid
+ - 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: software
+ schema:
+ type: string
+ format: uuid
+ - in: query
+ name: software__n
+ schema:
+ type: string
+ format: uuid
+ - 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
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableVulnerabilityLCMRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableVulnerabilityLCMRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/VulnerabilityLCMRequest'
+ 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/PatchedVulnerabilityLCMRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - tenancy
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableTenantGroupRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - tenancy
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableTenantGroupRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/TenantGroup'
+ description: ''
+ patch:
+ operationId: tenancy_tenant_groups_bulk_partial_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - tenancy
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableTenantGroupRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/TenantGroup'
+ description: ''
+ delete:
+ operationId: tenancy_tenant_groups_bulk_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - tenancy
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /tenancy/tenant-groups/{id}/:
+ get:
+ operationId: tenancy_tenant_groups_retrieve
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/WritableTenantGroupRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/PatchedWritableTenantGroupRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/TenantGroup'
+ description: ''
+ delete:
+ operationId: tenancy_tenant_groups_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/tenant-groups/{id}/notes/:
+ get:
+ operationId: tenancy_tenant_groups_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this tenant group.
+ 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:
+ - tenancy
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: tenancy_tenant_groups_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /tenancy/tenants/:
+ get:
+ operationId: tenancy_tenants_list
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: has_locations
+ schema:
+ type: boolean
+ description: Has locations
+ - 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: locations
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Locations (slugs and/or IDs)
+ explode: true
+ style: form
+ - in: query
+ name: locations__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Locations (slugs and/or IDs)
+ 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
+ - 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - tenancy
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableTenantRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - tenancy
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableTenantRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/Tenant'
+ description: ''
+ patch:
+ operationId: tenancy_tenants_bulk_partial_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - tenancy
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableTenantRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/Tenant'
+ description: ''
+ delete:
+ operationId: tenancy_tenants_bulk_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - tenancy
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /tenancy/tenants/{id}/:
+ get:
+ operationId: tenancy_tenants_retrieve
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/WritableTenantRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/PatchedWritableTenantRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Tenant'
+ description: ''
+ delete:
+ operationId: tenancy_tenants_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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
+ /tenancy/tenants/{id}/notes/:
+ get:
+ operationId: tenancy_tenants_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this tenant.
+ 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:
+ - tenancy
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: tenancy_tenants_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /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/GroupRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableGroupRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableGroupRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationIntegerIDRequest'
+ required: true
+ /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/GroupRequest'
+ 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/PatchedGroupRequest'
+ 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/WritableObjectPermissionRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableObjectPermissionRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableObjectPermissionRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/WritableObjectPermissionRequest'
+ 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/PatchedWritableObjectPermissionRequest'
+ 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/TokenRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableTokenRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ - basicAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableTokenRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ - basicAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/TokenRequest'
+ 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/PatchedTokenRequest'
+ 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/WritableUserRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableUserRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableUserRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/WritableUserRequest'
+ 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/PatchedWritableUserRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ parameters:
+ - in: query
+ name: clusters
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Clusters (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: clusters__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Clusters (name or 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: 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: has_clusters
+ schema:
+ type: boolean
+ description: Has clusters
+ - 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - virtualization
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ClusterGroupRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - virtualization
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableClusterGroupRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/ClusterGroup'
+ description: ''
+ patch:
+ operationId: virtualization_cluster_groups_bulk_partial_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - virtualization
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableClusterGroupRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/ClusterGroup'
+ description: ''
+ delete:
+ operationId: virtualization_cluster_groups_bulk_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - virtualization
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /virtualization/cluster-groups/{id}/:
+ get:
+ operationId: virtualization_cluster_groups_retrieve
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/ClusterGroupRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/PatchedClusterGroupRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/ClusterGroup'
+ description: ''
+ delete:
+ operationId: virtualization_cluster_groups_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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-groups/{id}/notes/:
+ get:
+ operationId: virtualization_cluster_groups_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this cluster group.
+ 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:
+ - virtualization
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: virtualization_cluster_groups_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /virtualization/cluster-types/:
+ get:
+ operationId: virtualization_cluster_types_list
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ parameters:
+ - in: query
+ name: clusters
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Clusters (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: clusters__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Clusters (name or 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: 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: has_clusters
+ schema:
+ type: boolean
+ description: Has clusters
+ - 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - virtualization
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ClusterTypeRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - virtualization
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableClusterTypeRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/ClusterType'
+ description: ''
+ patch:
+ operationId: virtualization_cluster_types_bulk_partial_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - virtualization
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableClusterTypeRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/ClusterType'
+ description: ''
+ delete:
+ operationId: virtualization_cluster_types_bulk_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - virtualization
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /virtualization/cluster-types/{id}/:
+ get:
+ operationId: virtualization_cluster_types_retrieve
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/ClusterTypeRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/PatchedClusterTypeRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/ClusterType'
+ description: ''
+ delete:
+ operationId: virtualization_cluster_types_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/cluster-types/{id}/notes/:
+ get:
+ operationId: virtualization_cluster_types_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this cluster type.
+ 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:
+ - virtualization
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: virtualization_cluster_types_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /virtualization/clusters/:
+ get:
+ operationId: virtualization_clusters_list
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ parameters:
+ - in: query
+ name: comments
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__ic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__ie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__iew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__ire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__isw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__n
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__nic
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__nie
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__niew
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__nire
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__nisw
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__nre
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
+ - in: query
+ name: comments__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: devices
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Devices (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: devices__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Devices (name or ID)
+ explode: true
+ style: form
+ - 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: has_devices
+ schema:
+ type: boolean
+ description: Has devices
+ - in: query
+ name: has_virtual_machines
+ schema:
+ type: boolean
+ description: Has virtual machines
+ - 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: location
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Location (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: location__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Location (slug or 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 or ID)
+ explode: true
+ style: form
+ - in: query
+ name: region__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Region (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: region_id
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Region (ID) (deprecated, use "region" filter instead)
+ explode: true
+ style: form
+ - in: query
+ name: region_id__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Region (ID) (deprecated, use "region" filter instead)
+ explode: true
+ style: form
+ - in: query
+ name: site
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Site (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: site__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Site (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: site_id
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ nullable: true
+ description: Site (ID) (deprecated, use "site" filter instead)
+ explode: true
+ style: form
+ - in: query
+ name: site_id__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ nullable: true
+ description: Site (ID) (deprecated, use "site" filter instead)
+ 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
+ format: uuid
+ description: Tenant (slug or ID)
+ explode: true
+ style: form
+ - in: query
+ name: tenant__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Tenant (slug or ID)
+ 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) (deprecated, use "tenant" filter instead)
+ explode: true
+ style: form
+ - in: query
+ name: tenant_id__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ nullable: true
+ description: Tenant (ID) (deprecated, use "tenant" filter instead)
+ 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
+ - in: query
+ name: virtual_machines
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Virtual machines (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: virtual_machines__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Virtual machines (name or 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - virtualization
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableClusterRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - virtualization
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableClusterRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/Cluster'
+ description: ''
+ patch:
+ operationId: virtualization_clusters_bulk_partial_update
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - virtualization
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableClusterRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/Cluster'
+ description: ''
+ delete:
+ operationId: virtualization_clusters_bulk_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ tags:
+ - virtualization
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /virtualization/clusters/{id}/:
+ get:
+ operationId: virtualization_clusters_retrieve
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/WritableClusterRequest'
+ 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: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/PatchedWritableClusterRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Cluster'
+ description: ''
+ delete:
+ operationId: virtualization_clusters_destroy
+ description: |-
+ Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support Notes.
+ 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/clusters/{id}/notes/:
+ get:
+ operationId: virtualization_clusters_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this cluster.
+ 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:
+ - virtualization
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: virtualization_clusters_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /virtualization/interfaces/:
+ get:
+ operationId: virtualization_interfaces_list
+ description: Mixin to set `metadata_class` to implement `status` field in model
+ viewset metadata.
+ parameters:
+ - in: query
+ name: bridge
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Bridge interface (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: bridge__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Bridge interface (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: bridged_interfaces
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Bridged interfaces (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: bridged_interfaces__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Bridged interfaces (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: child_interfaces
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Child interfaces (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: child_interfaces__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Child interfaces (name or ID)
+ explode: true
+ style: form
+ - 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: 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: enabled
+ schema:
+ type: boolean
+ - in: query
+ name: has_bridged_interfaces
+ schema:
+ type: boolean
+ description: Has Bridged Interfaces
+ - in: query
+ name: has_child_interfaces
+ schema:
+ type: boolean
+ description: Has child interfaces
+ - in: query
+ name: has_ip_addresses
+ schema:
+ type: boolean
+ description: Has IP addresses
+ - in: query
+ name: has_tagged_vlans
+ schema:
+ type: boolean
+ description: Has Tagged VLANs
+ - 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: ip_addresses
+ schema:
+ type: array
+ items:
+ type: string
+ description: IP addresses (address or 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
+ 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: 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: parent_interface
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Parent interface (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: parent_interface__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Parent interface (name or ID)
+ explode: true
+ style: form
+ - in: query
+ name: q
+ schema:
+ type: string
+ description: Search
+ - 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: tagged_vlans
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Tagged VLANs (VID or ID)
+ explode: true
+ style: form
+ - in: query
+ name: tagged_vlans__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Tagged VLANs (VID or ID)
+ explode: true
+ style: form
+ - in: query
+ name: untagged_vlan
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Untagged VLAN (VID or ID)
+ explode: true
+ style: form
+ - in: query
+ name: untagged_vlan__n
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ description: Untagged VLAN (VID or ID)
+ 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/PaginatedVMInterfaceSerializerVersion12List'
+ description: ''
+ post:
+ operationId: virtualization_interfaces_create
+ description: Mixin to set `metadata_class` to implement `status` field in model
+ viewset metadata.
+ tags:
+ - virtualization
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableVMInterfaceRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/VMInterfaceSerializerVersion12'
+ description: ''
+ put:
+ operationId: virtualization_interfaces_bulk_update
+ description: Mixin to set `metadata_class` to implement `status` field in model
+ viewset metadata.
+ tags:
+ - virtualization
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableVMInterfaceRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/VMInterfaceSerializerVersion12'
+ description: ''
+ patch:
+ operationId: virtualization_interfaces_bulk_partial_update
+ description: Mixin to set `metadata_class` to implement `status` field in model
+ viewset metadata.
+ tags:
+ - virtualization
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableVMInterfaceRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/VMInterfaceSerializerVersion12'
+ description: ''
+ delete:
+ operationId: virtualization_interfaces_bulk_destroy
+ description: Mixin to set `metadata_class` to implement `status` field in model
+ viewset metadata.
+ tags:
+ - virtualization
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /virtualization/interfaces/{id}/:
+ get:
+ operationId: virtualization_interfaces_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 VM interface.
+ required: true
+ tags:
+ - virtualization
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/VMInterfaceSerializerVersion12'
+ description: ''
+ put:
+ operationId: virtualization_interfaces_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 VM interface.
+ required: true
+ tags:
+ - virtualization
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WritableVMInterfaceRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/VMInterfaceSerializerVersion12'
+ description: ''
+ patch:
+ operationId: virtualization_interfaces_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 VM interface.
+ required: true
+ tags:
+ - virtualization
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PatchedWritableVMInterfaceRequest'
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/VMInterfaceSerializerVersion12'
+ description: ''
+ delete:
+ operationId: virtualization_interfaces_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 VM interface.
+ required: true
+ tags:
+ - virtualization
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '204':
+ description: No response body
+ /virtualization/interfaces/{id}/notes/:
+ get:
+ operationId: virtualization_interfaces_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this VM interface.
+ 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:
+ - virtualization
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: virtualization_interfaces_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+ /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:
+ - name: cluster
+ required: false
+ in: query
+ description: cluster
+ schema:
+ type: string
+ - name: cluster__n
+ required: false
+ in: query
+ description: cluster__n
+ schema:
+ type: string
+ - name: cluster_group
+ required: false
+ in: query
+ description: Cluster group (slug)
+ schema:
+ type: string
+ - name: cluster_group__n
+ required: false
+ in: query
+ description: Cluster group (slug)
+ schema:
+ type: string
+ - name: cluster_group_id
+ required: false
+ in: query
+ description: Cluster group (ID)
+ schema:
+ type: string
+ - name: cluster_group_id__n
+ required: false
+ in: query
+ description: Cluster group (ID)
+ schema:
+ type: string
+ - name: cluster_id
+ required: false
+ in: query
+ description: Cluster (ID)
+ schema:
+ type: string
+ - name: cluster_id__n
+ required: false
+ in: query
+ description: Cluster (ID)
+ schema:
+ type: string
+ - name: cluster_type
+ required: false
+ in: query
+ description: Cluster type (slug)
+ schema:
+ type: string
+ - name: cluster_type__n
+ required: false
+ in: query
+ description: Cluster type (slug)
+ schema:
+ type: string
+ - name: cluster_type_id
+ required: false
+ in: query
+ description: Cluster type (ID)
+ schema:
+ type: string
+ - name: cluster_type_id__n
+ required: false
+ in: query
+ description: Cluster type (ID)
+ schema:
+ type: string
+ - name: comments
+ required: false
+ in: query
+ description: comments
+ schema:
+ type: string
+ - name: comments__ic
+ required: false
+ in: query
+ description: comments__ic
+ schema:
+ type: string
+ - name: comments__ie
+ required: false
+ in: query
+ description: comments__ie
+ schema:
+ type: string
+ - name: comments__iew
+ required: false
+ in: query
+ description: comments__iew
+ schema:
+ type: string
+ - name: comments__ire
+ required: false
+ in: query
+ description: comments__ire
+ schema:
+ type: string
+ - name: comments__isw
+ required: false
+ in: query
+ description: comments__isw
+ schema:
+ type: string
+ - name: comments__n
+ required: false
+ in: query
+ description: comments__n
+ schema:
+ type: string
+ - name: comments__nic
+ required: false
+ in: query
+ description: comments__nic
+ schema:
+ type: string
+ - name: comments__nie
+ required: false
+ in: query
+ description: comments__nie
+ schema:
+ type: string
+ - name: comments__niew
+ required: false
+ in: query
+ description: comments__niew
+ schema:
+ type: string
+ - name: comments__nire
+ required: false
+ in: query
+ description: comments__nire
+ schema:
+ type: string
+ - name: comments__nisw
+ required: false
+ in: query
+ description: comments__nisw
+ schema:
+ type: string
+ - name: comments__nre
+ required: false
+ in: query
+ description: comments__nre
+ schema:
+ type: string
+ - name: comments__re
+ required: false
+ in: query
+ description: comments__re
+ schema:
+ type: string
+ - name: created
+ required: false
+ in: query
+ description: created
+ schema:
+ type: string
+ - name: created__gte
+ required: false
+ in: query
+ description: created__gte
+ schema:
+ type: string
+ - name: created__lte
+ required: false
+ in: query
+ description: created__lte
+ schema:
+ type: string
+ - name: disk
+ required: false
+ in: query
+ description: disk
+ schema:
+ type: string
+ - name: disk__gt
+ required: false
+ in: query
+ description: disk__gt
+ schema:
+ type: string
+ - name: disk__gte
+ required: false
+ in: query
+ description: disk__gte
+ schema:
+ type: string
+ - name: disk__lt
+ required: false
+ in: query
+ description: disk__lt
+ schema:
+ type: string
+ - name: disk__lte
+ required: false
+ in: query
+ description: disk__lte
+ schema:
+ type: string
+ - name: disk__n
+ required: false
+ in: query
+ description: disk__n
+ schema:
+ type: string
+ - name: has_interfaces
+ required: false
+ in: query
+ description: Has interfaces
+ schema:
+ type: string
+ - name: has_primary_ip
+ required: false
+ in: query
+ description: Has a primary IP
+ schema:
+ type: string
+ - name: has_services
+ required: false
+ in: query
+ description: Has services
+ schema:
+ type: string
+ - name: id
+ required: false
+ in: query
+ description: id
+ schema:
+ type: string
+ - name: id__ic
+ required: false
+ in: query
+ description: id__ic
+ schema:
+ type: string
+ - name: id__ie
+ required: false
+ in: query
+ description: id__ie
+ schema:
+ type: string
+ - name: id__iew
+ required: false
+ in: query
+ description: id__iew
+ schema:
+ type: string
+ - name: id__ire
+ required: false
+ in: query
+ description: id__ire
+ schema:
+ type: string
+ - name: id__isw
+ required: false
+ in: query
+ description: id__isw
+ schema:
+ type: string
+ - name: id__n
+ required: false
+ in: query
+ description: id__n
+ schema:
+ type: string
+ - name: id__nic
+ required: false
+ in: query
+ description: id__nic
+ schema:
+ type: string
+ - name: id__nie
+ required: false
+ in: query
+ description: id__nie
+ schema:
+ type: string
+ - name: id__niew
+ required: false
+ in: query
+ description: id__niew
+ schema:
+ type: string
+ - name: id__nire
+ required: false
+ in: query
+ description: id__nire
+ schema:
+ type: string
+ - name: id__nisw
+ required: false
+ in: query
+ description: id__nisw
+ schema:
+ type: string
+ - name: id__nre
+ required: false
+ in: query
+ description: id__nre
+ schema:
+ type: string
+ - name: id__re
+ required: false
+ in: query
+ description: id__re
+ schema:
+ type: string
+ - name: interfaces
+ required: false
+ in: query
+ description: Interfaces (name or ID)
+ schema:
+ type: string
+ - name: interfaces__n
+ required: false
+ in: query
+ description: Interfaces (name or ID)
+ schema:
+ type: string
+ - name: last_updated
+ required: false
+ in: query
+ description: last_updated
+ schema:
+ type: string
+ - name: last_updated__gte
+ required: false
+ in: query
+ description: last_updated__gte
+ schema:
+ type: string
+ - name: last_updated__lte
+ required: false
+ in: query
+ description: last_updated__lte
+ schema:
+ type: string
+ - name: limit
+ required: false
+ in: query
+ description: Number of results to return per page.
+ schema:
+ type: integer
+ - name: local_context_data
+ required: false
+ in: query
+ description: Has local config context data
+ schema:
+ type: string
+ - name: local_context_schema
+ required: false
+ in: query
+ description: Schema (slug)
+ schema:
+ type: string
+ - name: local_context_schema__n
+ required: false
+ in: query
+ description: Schema (slug)
+ schema:
+ type: string
+ - name: local_context_schema_id
+ required: false
+ in: query
+ description: Schema (ID)
+ schema:
+ type: string
+ - name: local_context_schema_id__n
+ required: false
+ in: query
+ description: Schema (ID)
+ schema:
+ type: string
+ - name: location
+ required: false
+ in: query
+ description: Location (slug or ID)
+ schema:
+ type: string
+ - name: location__n
+ required: false
+ in: query
+ description: Location (slug or ID)
+ schema:
+ type: string
+ - name: mac_address
+ required: false
+ in: query
+ description: MAC address
+ schema:
+ type: string
+ - name: mac_address__ic
+ required: false
+ in: query
+ description: MAC address
+ schema:
+ type: string
+ - name: mac_address__ie
+ required: false
+ in: query
+ description: MAC address
+ schema:
+ type: string
+ - name: mac_address__iew
+ required: false
+ in: query
+ description: MAC address
+ schema:
+ type: string
+ - name: mac_address__ire
+ required: false
+ in: query
+ description: MAC address
+ schema:
+ type: string
+ - name: mac_address__isw
+ required: false
+ in: query
+ description: MAC address
+ schema:
+ type: string
+ - name: mac_address__n
+ required: false
+ in: query
+ description: MAC address
+ schema:
+ type: string
+ - name: mac_address__nic
+ required: false
+ in: query
+ description: MAC address
+ schema:
+ type: string
+ - name: mac_address__nie
+ required: false
+ in: query
+ description: MAC address
+ schema:
+ type: string
+ - name: mac_address__niew
+ required: false
+ in: query
+ description: MAC address
+ schema:
+ type: string
+ - name: mac_address__nire
+ required: false
+ in: query
+ description: MAC address
+ schema:
+ type: string
+ - name: mac_address__nisw
+ required: false
+ in: query
+ description: MAC address
+ schema:
+ type: string
+ - name: mac_address__nre
+ required: false
+ in: query
+ description: MAC address
+ schema:
+ type: string
+ - name: mac_address__re
+ required: false
+ in: query
+ description: MAC address
+ schema:
+ type: string
+ - name: memory
+ required: false
+ in: query
+ description: memory
+ schema:
+ type: string
+ - name: memory__gt
+ required: false
+ in: query
+ description: memory__gt
+ schema:
+ type: string
+ - name: memory__gte
+ required: false
+ in: query
+ description: memory__gte
+ schema:
+ type: string
+ - name: memory__lt
+ required: false
+ in: query
+ description: memory__lt
+ schema:
+ type: string
+ - name: memory__lte
+ required: false
+ in: query
+ description: memory__lte
+ schema:
+ type: string
+ - name: memory__n
+ required: false
+ in: query
+ description: memory__n
+ schema:
+ type: string
+ - name: name
+ required: false
+ in: query
+ description: name
+ schema:
+ type: string
+ - name: name__ic
+ required: false
+ in: query
+ description: name__ic
+ schema:
+ type: string
+ - name: name__ie
+ required: false
+ in: query
+ description: name__ie
+ schema:
+ type: string
+ - name: name__iew
+ required: false
+ in: query
+ description: name__iew
+ schema:
+ type: string
+ - name: name__ire
+ required: false
+ in: query
+ description: name__ire
+ schema:
+ type: string
+ - name: name__isw
+ required: false
+ in: query
+ description: name__isw
+ schema:
+ type: string
+ - name: name__n
+ required: false
+ in: query
+ description: name__n
+ schema:
+ type: string
+ - name: name__nic
+ required: false
+ in: query
+ description: name__nic
+ schema:
+ type: string
+ - name: name__nie
+ required: false
+ in: query
+ description: name__nie
+ schema:
+ type: string
+ - name: name__niew
+ required: false
+ in: query
+ description: name__niew
+ schema:
+ type: string
+ - name: name__nire
+ required: false
+ in: query
+ description: name__nire
+ schema:
+ type: string
+ - name: name__nisw
+ required: false
+ in: query
+ description: name__nisw
+ schema:
+ type: string
+ - name: name__nre
+ required: false
+ in: query
+ description: name__nre
+ schema:
+ type: string
+ - name: name__re
+ required: false
+ in: query
+ description: name__re
+ schema:
+ type: string
+ - name: offset
+ required: false
+ in: query
+ description: The initial index from which to return the results.
+ schema:
+ type: integer
+ - name: platform
+ required: false
+ in: query
+ description: Platform (slug)
+ schema:
+ type: string
+ - name: platform__n
+ required: false
+ in: query
+ description: Platform (slug)
+ schema:
+ type: string
+ - name: platform_id
+ required: false
+ in: query
+ description: Platform (ID)
+ schema:
+ type: string
+ - name: platform_id__n
+ required: false
+ in: query
+ description: Platform (ID)
+ schema:
+ type: string
+ - name: primary_ip4
+ required: false
+ in: query
+ description: Primary IPv4 Address (address or ID)
+ schema:
+ type: string
+ - name: primary_ip6
+ required: false
+ in: query
+ description: Primary IPv6 Address (address or ID)
+ schema:
+ type: string
+ - name: q
+ required: false
+ in: query
+ description: Search
+ schema:
+ type: string
+ - name: region
+ required: false
+ in: query
+ description: Region (slug)
+ schema:
+ type: string
+ - name: region__n
+ required: false
+ in: query
+ description: Region (slug)
+ schema:
+ type: string
+ - name: region_id
+ required: false
+ in: query
+ description: Region (ID)
+ schema:
+ type: string
+ - name: region_id__n
+ required: false
+ in: query
+ description: Region (ID)
+ schema:
+ type: string
+ - name: role
+ required: false
+ in: query
+ description: Role (slug)
+ schema:
+ type: string
+ - name: role__n
+ required: false
+ in: query
+ description: Role (slug)
+ schema:
+ type: string
+ - name: role_id
+ required: false
+ in: query
+ description: Role (ID)
+ schema:
+ type: string
+ - name: role_id__n
+ required: false
+ in: query
+ description: Role (ID)
+ schema:
+ type: string
+ - name: services
+ required: false
+ in: query
+ description: Services (name or ID)
+ schema:
+ type: string
+ - name: services__n
+ required: false
+ in: query
+ description: Services (name or ID)
+ schema:
+ type: string
+ - name: site
+ required: false
+ in: query
+ description: Site (slug)
+ schema:
+ type: string
+ - name: site__n
+ required: false
+ in: query
+ description: Site (slug)
+ schema:
+ type: string
+ - name: site_id
+ required: false
+ in: query
+ description: Site (ID)
+ schema:
+ type: string
+ - name: site_id__n
+ required: false
+ in: query
+ description: Site (ID)
+ schema:
+ type: string
+ - name: status
+ required: false
+ in: query
+ description: status
+ schema:
+ type: string
+ - name: status__n
+ required: false
+ in: query
+ description: status__n
+ schema:
+ type: string
+ - name: tag
+ required: false
+ in: query
+ description: tag
+ schema:
+ type: string
+ - name: tag__n
+ required: false
+ in: query
+ description: tag__n
+ schema:
+ type: string
+ - name: tenant
+ required: false
+ in: query
+ description: Tenant (slug or ID)
+ schema:
+ type: string
+ - name: tenant__n
+ required: false
+ in: query
+ description: Tenant (slug or ID)
+ schema:
+ type: string
+ - name: tenant_group
+ required: false
+ in: query
+ description: Tenant Group (slug)
+ schema:
+ type: string
+ - name: tenant_group__n
+ required: false
+ in: query
+ description: Tenant Group (slug)
+ schema:
+ type: string
+ - name: tenant_group_id
+ required: false
+ in: query
+ description: Tenant Group (ID)
+ schema:
+ type: string
+ - name: tenant_group_id__n
+ required: false
+ in: query
+ description: Tenant Group (ID)
+ schema:
+ type: string
+ - name: tenant_id
+ required: false
+ in: query
+ description: Tenant (ID) (deprecated, use "tenant" filter instead)
+ schema:
+ type: string
+ - name: tenant_id__n
+ required: false
+ in: query
+ description: Tenant (ID) (deprecated, use "tenant" filter instead)
+ schema:
+ type: string
+ - name: vcpus
+ required: false
+ in: query
+ description: vcpus
+ schema:
+ type: string
+ - name: vcpus__gt
+ required: false
+ in: query
+ description: vcpus__gt
+ schema:
+ type: string
+ - name: vcpus__gte
+ required: false
+ in: query
+ description: vcpus__gte
+ schema:
+ type: string
+ - name: vcpus__lt
+ required: false
+ in: query
+ description: vcpus__lt
+ schema:
+ type: string
+ - name: vcpus__lte
+ required: false
+ in: query
+ description: vcpus__lte
+ schema:
+ type: string
+ - name: vcpus__n
+ required: false
+ in: query
+ description: vcpus__n
+ schema:
+ type: string
+ 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/WritableVirtualMachineWithConfigContextRequest'
+ 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:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableVirtualMachineWithConfigContextRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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:
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableVirtualMachineWithConfigContextRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ type: array
+ items:
+ $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
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkOperationRequest'
+ required: true
+ /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/WritableVirtualMachineWithConfigContextRequest'
+ 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/PatchedWritableVirtualMachineWithConfigContextRequest'
+ 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
+ /virtualization/virtual-machines/{id}/notes/:
+ get:
+ operationId: virtualization_virtual_machines_notes_list
+ description: API methods for returning or creating notes on an object.
+ parameters:
+ - in: path
+ name: id
+ schema:
+ type: string
+ format: uuid
+ description: A UUID string identifying this virtual machine.
+ 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:
+ - virtualization
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '200':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/PaginatedNoteList'
+ description: ''
+ post:
+ operationId: virtualization_virtual_machines_notes_create
+ description: API methods for returning or creating notes on an object.
+ 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/NoteInputRequest'
+ required: true
+ security:
+ - cookieAuth: []
+ - tokenAuth: []
+ responses:
+ '201':
+ content:
+ application/json; version=1.3:
+ schema:
+ $ref: '#/components/schemas/Note'
+ description: ''
+components:
+ schemas:
+ AccessGrant:
+ type: object
+ description: API serializer for interacting with AccessGrant objects.
+ properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ command:
+ type: string
+ description: Enter * to grant access to all commands
+ maxLength: 64
+ subcommand:
+ type: string
+ description: Enter * 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.
Enter *
+ to grant access to all organizations, channels, or users
+ maxLength: 255
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ required:
+ - command
+ - created
+ - display
+ - grant_type
+ - id
+ - last_updated
+ - name
+ - subcommand
+ - url
+ - value
+ AccessGrantRequest:
+ type: object
+ description: API serializer for interacting with AccessGrant objects.
+ properties:
+ command:
+ type: string
+ minLength: 1
+ description: Enter * to grant access to all commands
+ maxLength: 64
+ subcommand:
+ type: string
+ minLength: 1
+ description: Enter * to grant access to all subcommands of the
+ given command
+ maxLength: 64
+ grant_type:
+ $ref: '#/components/schemas/GrantTypeEnum'
+ name:
+ type: string
+ minLength: 1
+ description: Organization name, channel name, or user name
+ maxLength: 255
+ value:
+ type: string
+ minLength: 1
+ description: Corresponding ID value to grant access to.
Enter *
+ to grant access to all organizations, channels, or users
+ maxLength: 255
+ required:
+ - command
+ - grant_type
+ - name
+ - subcommand
+ - value
+ AccessTypeEnum:
+ enum:
+ - Generic
+ - Console
+ - gNMI
+ - HTTP(S)
+ - NETCONF
+ - REST
+ - RESTCONF
+ - SNMP
+ - SSH
+ type: string
+ ActionEnum:
+ enum:
+ - allow
+ - deny
+ - drop
+ - remark
+ type: string
+ AddressFamily:
+ type: object
+ description: REST API serializer for AddressFamily records.
+ properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ afi_safi:
+ $ref: '#/components/schemas/AfiSafiEnum'
+ routing_instance:
+ $ref: '#/components/schemas/NestedRoutingInstance'
+ vrf:
+ allOf:
+ - $ref: '#/components/schemas/NestedVRF'
+ nullable: true
+ export_policy:
+ type: string
+ maxLength: 100
+ import_policy:
+ type: string
+ maxLength: 100
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - afi_safi
+ - created
+ - display
+ - id
+ - last_updated
+ - routing_instance
+ - url
+ AddressObject:
+ type: object
+ description: AddressObject Serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ ip_range:
+ $ref: '#/components/schemas/NestedIPRange'
+ fqdn:
+ $ref: '#/components/schemas/NestedFQDN'
+ ip_address:
+ $ref: '#/components/schemas/NestedIPAddress'
+ prefix:
+ $ref: '#/components/schemas/NestedPrefix'
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ description: Name descriptor for an address object type.
+ maxLength: 100
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - url
+ AddressObjectGroup:
+ type: object
+ description: AddressObjectGroup Serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ address_objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ ip_range:
+ $ref: '#/components/schemas/NestedIPRange'
+ fqdn:
+ $ref: '#/components/schemas/NestedFQDN'
+ ip_address:
+ $ref: '#/components/schemas/NestedIPAddress'
+ prefix:
+ $ref: '#/components/schemas/NestedPrefix'
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ description: Name descriptor for an address object type.
+ maxLength: 100
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - url
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ description: Name descriptor for a group address objects.
+ maxLength: 100
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - url
+ AfiSafiEnum:
+ enum:
+ - ipv4_unicast
+ - ipv4_multicast
+ - ipv4_flowspec
+ - ipv6_unicast
+ - ipv6_multicast
+ - ipv6_flowspec
+ - vpnv4_unicast
+ - vpnv4_multicast
+ - vpnv6_unicast
+ - vpnv6_multicast
+ - l2_evpn
+ - l2_vpls
+ type: string
+ Aggregate:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ 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
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - created
+ - display
+ - family
+ - id
+ - last_updated
+ - notes_url
+ - prefix
+ - rir
+ - url
+ AutonomousSystem:
+ type: object
+ description: REST API serializer for AutonomousSystem records.
+ properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ asn:
+ type: integer
+ maximum: 4294967295
+ minimum: 1
+ format: int64
+ description: 32-bit autonomous system number
+ description:
+ type: string
+ maxLength: 200
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - available
+ - planned
+ label:
+ type: string
+ enum:
+ - Active
+ - Available
+ - Planned
+ provider:
+ allOf:
+ - $ref: '#/components/schemas/NestedProvider'
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - asn
+ - created
+ - display
+ - id
+ - last_updated
+ - status
+ - 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
+ BGPRoutingInstance:
+ type: object
+ description: REST API serializer for Peering records.
+ properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ device:
+ $ref: '#/components/schemas/NestedDevice'
+ description:
+ type: string
+ maxLength: 200
+ router_id:
+ allOf:
+ - $ref: '#/components/schemas/NestedIPAddress'
+ nullable: true
+ autonomous_system:
+ allOf:
+ - $ref: '#/components/schemas/NestedAutonomousSystem'
+ nullable: true
+ endpoints:
+ type: array
+ items:
+ $ref: '#/components/schemas/NestedPeerEndpoint'
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - created
+ - device
+ - display
+ - id
+ - last_updated
+ - url
+ BlankEnum:
+ enum:
+ - ''
+ BulkOperationIntegerIDRequest:
+ type: object
+ description: As BulkOperationSerializer, but for models such as users.Group
+ that have an integer ID field.
+ properties:
+ id:
+ type: integer
+ required:
+ - id
+ BulkOperationRequest:
+ type: object
+ description: Representation of bulk-DELETE request for most models; also used
+ to validate required ID field for bulk-PATCH/PUT.
+ properties:
+ id:
+ type: string
+ format: uuid
+ required:
+ - id
+ BulkWritableAccessGrantRequest:
+ type: object
+ description: API serializer for interacting with AccessGrant objects.
+ properties:
+ id:
+ type: string
+ format: uuid
+ command:
+ type: string
+ minLength: 1
+ description: Enter * to grant access to all commands
+ maxLength: 64
+ subcommand:
+ type: string
+ minLength: 1
+ description: Enter * to grant access to all subcommands of the
+ given command
+ maxLength: 64
+ grant_type:
+ $ref: '#/components/schemas/GrantTypeEnum'
+ name:
+ type: string
+ minLength: 1
+ description: Organization name, channel name, or user name
+ maxLength: 255
+ value:
+ type: string
+ minLength: 1
+ description: Corresponding ID value to grant access to.
Enter *
+ to grant access to all organizations, channels, or users
+ maxLength: 255
+ required:
+ - command
+ - grant_type
+ - id
+ - name
+ - subcommand
+ - value
+ BulkWritableAddressFamilyRequest:
+ type: object
+ description: REST API serializer for AddressFamily records.
+ properties:
+ id:
+ type: string
+ format: uuid
+ afi_safi:
+ $ref: '#/components/schemas/AfiSafiEnum'
+ vrf:
+ allOf:
+ - $ref: '#/components/schemas/NestedVRFRequest'
+ nullable: true
+ export_policy:
+ type: string
+ maxLength: 100
+ import_policy:
+ type: string
+ maxLength: 100
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - afi_safi
+ - id
+ BulkWritableAddressObjectGroupRequest:
+ type: object
+ description: AddressObjectGroup Serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ address_objects:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ ip_range:
+ $ref: '#/components/schemas/NestedIPRangeRequest'
+ fqdn:
+ $ref: '#/components/schemas/NestedFQDNRequest'
+ ip_address:
+ $ref: '#/components/schemas/NestedIPAddressRequest'
+ prefix:
+ $ref: '#/components/schemas/NestedPrefixRequest'
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name descriptor for an address object type.
+ maxLength: 100
+ required:
+ - name
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name descriptor for a group address objects.
+ maxLength: 100
+ required:
+ - id
+ - name
+ BulkWritableAddressObjectRequest:
+ type: object
+ description: AddressObject Serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ ip_range:
+ $ref: '#/components/schemas/NestedIPRangeRequest'
+ fqdn:
+ $ref: '#/components/schemas/NestedFQDNRequest'
+ ip_address:
+ $ref: '#/components/schemas/NestedIPAddressRequest'
+ prefix:
+ $ref: '#/components/schemas/NestedPrefixRequest'
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name descriptor for an address object type.
+ maxLength: 100
+ required:
+ - id
+ - name
+ BulkWritableAggregateRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ prefix:
+ type: string
+ minLength: 1
+ rir:
+ $ref: '#/components/schemas/NestedRIRRequest'
+ tenant:
+ allOf:
+ - $ref: '#/components/schemas/NestedTenantRequest'
+ nullable: true
+ date_added:
+ type: string
+ format: date
+ nullable: true
+ description:
+ type: string
+ maxLength: 200
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ - prefix
+ - rir
+ BulkWritableAutonomousSystemRequest:
+ type: object
+ description: REST API serializer for AutonomousSystem records.
+ properties:
+ id:
+ type: string
+ format: uuid
+ asn:
+ type: integer
+ maximum: 4294967295
+ minimum: 1
+ format: int64
+ description: 32-bit autonomous system number
+ description:
+ type: string
+ maxLength: 200
+ status:
+ $ref: '#/components/schemas/Status2a0Enum'
+ provider:
+ allOf:
+ - $ref: '#/components/schemas/NestedProviderRequest'
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - asn
+ - id
+ - status
+ BulkWritableBGPRoutingInstanceRequest:
+ type: object
+ description: REST API serializer for Peering records.
+ properties:
+ id:
+ type: string
+ format: uuid
+ device:
+ $ref: '#/components/schemas/NestedDeviceRequest'
+ description:
+ type: string
+ maxLength: 200
+ router_id:
+ allOf:
+ - $ref: '#/components/schemas/NestedIPAddressRequest'
+ nullable: true
+ autonomous_system:
+ allOf:
+ - $ref: '#/components/schemas/NestedAutonomousSystemRequest'
+ nullable: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - device
+ - id
+ BulkWritableCVELCMRequest:
+ type: object
+ description: REST API serializer for CVELCM records.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 16
+ published_date:
+ type: string
+ format: date
+ link:
+ type: string
+ format: uri
+ minLength: 1
+ maxLength: 200
+ status:
+ $ref: '#/components/schemas/Status4f5Enum'
+ description:
+ type: string
+ nullable: true
+ maxLength: 255
+ severity:
+ $ref: '#/components/schemas/SeverityEnum'
+ 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/TagSerializerFieldRequest'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ - link
+ - name
+ - published_date
+ BulkWritableCableRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ termination_a_type:
+ type: string
+ termination_a_id:
+ type: string
+ format: uuid
+ termination_b_type:
+ type: string
+ termination_b_id:
+ type: string
+ format: uuid
+ type:
+ oneOf:
+ - $ref: '#/components/schemas/CableTypeChoices'
+ - $ref: '#/components/schemas/BlankEnum'
+ status:
+ $ref: '#/components/schemas/CableStatusChoices'
+ 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:
+ $ref: '#/components/schemas/LengthUnitEnum'
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ - status
+ - termination_a_id
+ - termination_a_type
+ - termination_b_id
+ - termination_b_type
+ BulkWritableCapircaPolicyRequest:
+ type: object
+ description: CapircaPolicy Serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ pol:
+ type: string
+ nullable: true
+ net:
+ type: string
+ nullable: true
+ svc:
+ type: string
+ nullable: true
+ cfg:
+ type: string
+ nullable: true
+ device:
+ type: string
+ format: uuid
+ nullable: true
+ required:
+ - id
+ BulkWritableCircuitMaintenanceCircuitImpactRequest:
+ type: object
+ description: Serializer for API.
+ properties:
+ id:
+ type: string
+ format: uuid
+ 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
+ BulkWritableCircuitMaintenanceRequest:
+ type: object
+ description: Serializer for API.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ 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/StatusD95Enum'
+ - $ref: '#/components/schemas/BlankEnum'
+ - $ref: '#/components/schemas/NullEnum'
+ ack:
+ type: boolean
+ nullable: true
+ required:
+ - end_time
+ - id
+ - start_time
+ BulkWritableCircuitRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ cid:
+ type: string
+ minLength: 1
+ title: Circuit ID
+ maxLength: 100
+ provider:
+ $ref: '#/components/schemas/NestedProviderRequest'
+ type:
+ $ref: '#/components/schemas/NestedCircuitTypeRequest'
+ status:
+ $ref: '#/components/schemas/CircuitStatusChoices'
+ tenant:
+ allOf:
+ - $ref: '#/components/schemas/NestedTenantRequest'
+ 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
+ comments:
+ type: string
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - cid
+ - id
+ - provider
+ - status
+ - type
+ BulkWritableCircuitTerminationRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ circuit:
+ $ref: '#/components/schemas/NestedCircuitRequest'
+ term_side:
+ allOf:
+ - $ref: '#/components/schemas/TermSideEnum'
+ title: Termination
+ site:
+ allOf:
+ - $ref: '#/components/schemas/NestedSiteRequest'
+ nullable: true
+ location:
+ allOf:
+ - $ref: '#/components/schemas/NestedLocationRequest'
+ nullable: true
+ provider_network:
+ allOf:
+ - $ref: '#/components/schemas/NestedProviderNetworkRequest'
+ 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
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - circuit
+ - id
+ - term_side
+ BulkWritableCircuitTypeRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ - name
+ BulkWritableClusterGroupRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ - name
+ BulkWritableClusterRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ type:
+ $ref: '#/components/schemas/NestedClusterTypeRequest'
+ group:
+ allOf:
+ - $ref: '#/components/schemas/NestedClusterGroupRequest'
+ nullable: true
+ tenant:
+ allOf:
+ - $ref: '#/components/schemas/NestedTenantRequest'
+ nullable: true
+ site:
+ allOf:
+ - $ref: '#/components/schemas/NestedSiteRequest'
+ nullable: true
+ location:
+ allOf:
+ - $ref: '#/components/schemas/NestedLocationRequest'
+ nullable: true
+ comments:
+ type: string
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ - name
+ - type
+ BulkWritableClusterTypeRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ - name
+ BulkWritableCommandTokenRequest:
+ type: object
+ description: API serializer for interacting with CommandToken objects.
+ properties:
+ id:
+ type: string
+ format: uuid
+ comment:
+ type: string
+ description: 'Optional: Enter description of token'
+ maxLength: 255
+ platform:
+ $ref: '#/components/schemas/PlatformEnum'
+ token:
+ type: string
+ minLength: 1
+ description: Token given by chat platform for signing or command validation
+ maxLength: 255
+ required:
+ - id
+ - platform
+ - token
+ BulkWritableComplianceFeatureRequest:
+ type: object
+ description: Serializer for ComplianceFeature object.
+ properties:
+ id:
+ type: string
+ format: uuid
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ minLength: 1
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ description:
+ type: string
+ maxLength: 200
+ required:
+ - id
+ - name
+ - slug
+ BulkWritableComplianceRuleRequest:
+ type: object
+ description: Serializer for ComplianceRule object.
+ properties:
+ id:
+ type: string
+ format: uuid
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _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:
+ - config_ordered
+ - feature
+ - id
+ - platform
+ BulkWritableComputedFieldRequest:
+ 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
+ slug:
+ type: string
+ description: Internal field name. Please use underscores rather than dashes
+ in this slug.
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ label:
+ type: string
+ minLength: 1
+ description: Name of the field as displayed to users
+ maxLength: 100
+ description:
+ type: string
+ maxLength: 200
+ content_type:
+ type: string
+ template:
+ type: string
+ minLength: 1
+ 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
+ required:
+ - content_type
+ - id
+ - label
+ - template
+ BulkWritableConfigComplianceRequest:
+ type: object
+ description: Serializer for ConfigCompliance object.
+ properties:
+ id:
+ type: string
+ format: uuid
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _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:
+ - device
+ - id
+ - rule
+ BulkWritableConfigContextRequest:
+ 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
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ owner_content_type:
+ type: string
+ nullable: true
+ owner_object_id:
+ type: string
+ format: uuid
+ nullable: true
+ weight:
+ type: integer
+ maximum: 32767
+ minimum: 0
+ description:
+ type: string
+ maxLength: 200
+ schema:
+ allOf:
+ - $ref: '#/components/schemas/NestedConfigContextSchemaRequest'
+ nullable: true
+ is_active:
+ type: boolean
+ regions:
+ type: array
+ items:
+ type: object
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ required:
+ - name
+ sites:
+ type: array
+ items:
+ type: object
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ required:
+ - name
+ locations:
+ type: array
+ items:
+ type: object
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ required:
+ - name
+ roles:
+ type: array
+ items:
+ type: object
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ required:
+ - name
+ device_types:
+ type: array
+ items:
+ type: object
+ properties:
+ model:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ required:
+ - model
+ - slug
+ platforms:
+ type: array
+ items:
+ type: object
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ required:
+ - name
+ cluster_groups:
+ type: array
+ items:
+ type: object
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ required:
+ - name
+ clusters:
+ type: array
+ items:
+ type: object
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ required:
+ - name
+ tenant_groups:
+ type: array
+ items:
+ type: object
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ required:
+ - name
+ tenants:
+ type: array
+ items:
+ type: object
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ required:
+ - name
+ tags:
+ type: array
+ items:
+ type: string
+ data:
+ type: object
+ additionalProperties: {}
+ required:
+ - data
+ - id
+ - name
+ BulkWritableConfigContextSchemaRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ 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
+ description:
+ type: string
+ maxLength: 200
+ data_schema:
+ type: object
+ additionalProperties: {}
+ description: A JSON Schema document which is used to validate a config context
+ object.
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - data_schema
+ - id
+ - name
+ BulkWritableConfigRemoveRequest:
+ type: object
+ description: Serializer for ConfigRemove object.
+ properties:
+ id:
+ type: string
+ format: uuid
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 255
+ description:
+ type: string
+ maxLength: 200
+ regex:
+ type: string
+ minLength: 1
+ title: Regex Pattern
+ description: Regex pattern used to remove a line from the backup configuration.
+ maxLength: 200
+ platform:
+ type: string
+ format: uuid
+ required:
+ - id
+ - name
+ - platform
+ - regex
+ BulkWritableConfigReplaceRequest:
+ type: object
+ description: Serializer for ConfigReplace object.
+ properties:
+ id:
+ type: string
+ format: uuid
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 255
+ description:
+ type: string
+ maxLength: 200
+ regex:
+ type: string
+ minLength: 1
+ title: Regex Pattern to Substitute
+ description: Regex pattern that will be found and replaced with 'replaced
+ text'.
+ maxLength: 200
+ replace:
+ type: string
+ minLength: 1
+ title: Replaced Text
+ description: Text that will be inserted in place of Regex pattern match.
+ maxLength: 200
+ platform:
+ type: string
+ format: uuid
+ required:
+ - id
+ - name
+ - platform
+ - regex
+ - replace
+ BulkWritableConsolePortRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ device:
+ $ref: '#/components/schemas/NestedDeviceRequest'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ label:
+ type: string
+ description: Physical label
+ maxLength: 64
+ type:
+ $ref: '#/components/schemas/ConsolePortTypeChoices'
+ description:
+ type: string
+ maxLength: 200
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - device
+ - id
+ - name
+ BulkWritableConsolePortTemplateRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ device_type:
+ $ref: '#/components/schemas/NestedDeviceTypeRequest'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ label:
+ type: string
+ description: Physical label
+ maxLength: 64
+ type:
+ $ref: '#/components/schemas/ConsolePortTypeChoices'
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - device_type
+ - id
+ - name
+ BulkWritableConsoleServerPortRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ device:
+ $ref: '#/components/schemas/NestedDeviceRequest'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ label:
+ type: string
+ description: Physical label
+ maxLength: 64
+ type:
+ $ref: '#/components/schemas/ConsolePortTypeChoices'
+ description:
+ type: string
+ maxLength: 200
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - device
+ - id
+ - name
+ BulkWritableConsoleServerPortTemplateRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ device_type:
+ $ref: '#/components/schemas/NestedDeviceTypeRequest'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ label:
+ type: string
+ description: Physical label
+ maxLength: 64
+ type:
+ $ref: '#/components/schemas/ConsolePortTypeChoices'
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - device_type
+ - id
+ - name
+ BulkWritableContactLCMRequest:
+ type: object
+ description: API serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ nullable: true
+ minLength: 1
+ 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/NestedContractLCMRequest'
+ description: Associated Contract
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - contract
+ - id
+ - name
+ BulkWritableContractLCMRequest:
+ type: object
+ description: API serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ provider:
+ allOf:
+ - $ref: '#/components/schemas/NestedProviderLCMRequest'
+ description: Vendor
+ name:
+ type: string
+ minLength: 1
+ 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
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ - name
+ - provider
+ BulkWritableCustomFieldChoiceRequest:
+ 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
+ field:
+ $ref: '#/components/schemas/NestedCustomFieldRequest'
+ value:
+ type: string
+ minLength: 1
+ maxLength: 100
+ weight:
+ type: integer
+ maximum: 32767
+ minimum: 0
+ description: Higher weights appear later in the list
+ required:
+ - field
+ - id
+ - value
+ BulkWritableCustomLinkRequest:
+ 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
+ target_url:
+ type: string
+ minLength: 1
+ title: URL
+ description: Jinja2 template code for link URL. Reference the object as
+ {{ obj }} such as {{ obj.platform.slug }}.
+ maxLength: 500
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ content_type:
+ type: string
+ text:
+ type: string
+ minLength: 1
+ description: Jinja2 template code for link text. Reference the object as
+ {{ obj }} such as {{ obj.platform.slug }}. 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
+ required:
+ - content_type
+ - id
+ - name
+ - new_window
+ - target_url
+ - text
+ BulkWritableDeviceBayRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ device:
+ $ref: '#/components/schemas/NestedDeviceRequest'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ label:
+ type: string
+ description: Physical label
+ maxLength: 64
+ description:
+ type: string
+ maxLength: 200
+ installed_device:
+ allOf:
+ - $ref: '#/components/schemas/NestedDeviceRequest'
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - device
+ - id
+ - name
+ BulkWritableDeviceBayTemplateRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ device_type:
+ $ref: '#/components/schemas/NestedDeviceTypeRequest'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ label:
+ type: string
+ description: Physical label
+ maxLength: 64
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - device_type
+ - id
+ - name
+ BulkWritableDeviceRedundancyGroupRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ description:
+ type: string
+ maxLength: 200
+ failover_strategy:
+ $ref: '#/components/schemas/FailoverStrategyEnum'
+ secrets_group:
+ type: string
+ format: uuid
+ nullable: true
+ comments:
+ type: string
+ status:
+ $ref: '#/components/schemas/LocationStatusChoices'
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - failover_strategy
+ - id
+ - name
+ - status
+ BulkWritableDeviceRoleRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ color:
+ type: string
+ minLength: 1
+ 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
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ - name
+ BulkWritableDeviceTypeRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ manufacturer:
+ $ref: '#/components/schemas/NestedManufacturerRequest'
+ model:
+ type: string
+ minLength: 1
+ 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:
+ $ref: '#/components/schemas/SubdeviceRoleEnum'
+ front_image:
+ type: string
+ format: binary
+ rear_image:
+ type: string
+ format: binary
+ comments:
+ type: string
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ - manufacturer
+ - model
+ BulkWritableDeviceWithConfigContextRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ nullable: true
+ maxLength: 64
+ device_type:
+ $ref: '#/components/schemas/NestedDeviceTypeRequest'
+ device_role:
+ $ref: '#/components/schemas/NestedDeviceRoleRequest'
+ tenant:
+ allOf:
+ - $ref: '#/components/schemas/NestedTenantRequest'
+ nullable: true
+ platform:
+ allOf:
+ - $ref: '#/components/schemas/NestedPlatformRequest'
+ 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/NestedSiteRequest'
+ location:
+ allOf:
+ - $ref: '#/components/schemas/NestedLocationRequest'
+ nullable: true
+ rack:
+ allOf:
+ - $ref: '#/components/schemas/NestedRackRequest'
+ nullable: true
+ position:
+ type: integer
+ maximum: 32767
+ minimum: 1
+ nullable: true
+ title: Position (U)
+ description: The lowest-numbered unit occupied by the device
+ face:
+ $ref: '#/components/schemas/FaceEnum'
+ status:
+ $ref: '#/components/schemas/DeviceStatusChoices'
+ primary_ip4:
+ allOf:
+ - $ref: '#/components/schemas/NestedIPAddressRequest'
+ nullable: true
+ primary_ip6:
+ allOf:
+ - $ref: '#/components/schemas/NestedIPAddressRequest'
+ nullable: true
+ secrets_group:
+ allOf:
+ - $ref: '#/components/schemas/NestedSecretsGroupRequest'
+ nullable: true
+ cluster:
+ allOf:
+ - $ref: '#/components/schemas/NestedClusterRequest'
+ nullable: true
+ virtual_chassis:
+ allOf:
+ - $ref: '#/components/schemas/NestedVirtualChassisRequest'
+ nullable: true
+ vc_position:
+ type: integer
+ maximum: 255
+ minimum: 0
+ nullable: true
+ vc_priority:
+ type: integer
+ maximum: 255
+ minimum: 0
+ nullable: true
+ device_redundancy_group:
+ allOf:
+ - $ref: '#/components/schemas/NestedDeviceRedundancyGroupRequest'
+ nullable: true
+ device_redundancy_group_priority:
+ type: integer
+ maximum: 32767
+ minimum: 1
+ nullable: true
+ description: The priority the device has in the device redundancy group.
+ comments:
+ type: string
+ local_context_schema:
+ allOf:
+ - $ref: '#/components/schemas/NestedConfigContextSchemaRequest'
+ nullable: true
+ local_context_data:
+ type: object
+ additionalProperties: {}
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - device_role
+ - device_type
+ - id
+ - site
+ - status
+ BulkWritableDynamicGroupMembershipRequest:
+ 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
+ group:
+ $ref: '#/components/schemas/NestedDynamicGroupRequest'
+ parent_group:
+ $ref: '#/components/schemas/NestedDynamicGroupRequest'
+ operator:
+ $ref: '#/components/schemas/OperatorEnum'
+ weight:
+ type: integer
+ maximum: 32767
+ minimum: 0
+ required:
+ - group
+ - id
+ - operator
+ - parent_group
+ - weight
+ BulkWritableDynamicGroupRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ 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
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - content_type
+ - filter
+ - id
+ - name
+ BulkWritableExportTemplateRequest:
+ type: object
+ description: Extend ValidatedModelSerializer with a `relationships` field.
+ properties:
+ id:
+ type: string
+ format: uuid
+ content_type:
+ type: string
+ owner_content_type:
+ type: string
+ nullable: true
+ owner_object_id:
+ type: string
+ format: uuid
+ nullable: true
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ description:
+ type: string
+ maxLength: 200
+ template_code:
+ type: string
+ minLength: 1
+ description: The list of objects being exported is passed as a context variable
+ named queryset.
+ mime_type:
+ type: string
+ description: Defaults to text/plain
+ maxLength: 50
+ file_extension:
+ type: string
+ description: Extension to append to the rendered filename
+ maxLength: 15
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - content_type
+ - id
+ - name
+ - template_code
+ BulkWritableFQDNRequest:
+ type: object
+ description: FQDN Serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ ip_addresses:
+ type: array
+ items:
+ type: object
+ properties:
+ address:
+ type: string
+ minLength: 1
+ required:
+ - address
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Resolvable fully qualified domain name (e.g. networktocode.com)
+ maxLength: 254
+ required:
+ - id
+ - name
+ BulkWritableFrontPortRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ device:
+ $ref: '#/components/schemas/NestedDeviceRequest'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ label:
+ type: string
+ description: Physical label
+ maxLength: 64
+ type:
+ $ref: '#/components/schemas/PortTypeChoices'
+ rear_port:
+ $ref: '#/components/schemas/FrontPortRearPortRequest'
+ rear_port_position:
+ type: integer
+ maximum: 1024
+ minimum: 1
+ default: 1
+ description:
+ type: string
+ maxLength: 200
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - device
+ - id
+ - name
+ - rear_port
+ - type
+ BulkWritableFrontPortTemplateRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ device_type:
+ $ref: '#/components/schemas/NestedDeviceTypeRequest'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ label:
+ type: string
+ description: Physical label
+ maxLength: 64
+ type:
+ $ref: '#/components/schemas/PortTypeChoices'
+ rear_port:
+ $ref: '#/components/schemas/NestedRearPortTemplateRequest'
+ rear_port_position:
+ type: integer
+ maximum: 1024
+ minimum: 1
+ default: 1
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - device_type
+ - id
+ - name
+ - rear_port
+ - type
+ BulkWritableGitRepositoryRequest:
+ type: object
+ description: Git repositories defined as a data source.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ remote_url:
+ type: string
+ format: uri
+ minLength: 1
+ description: Only HTTP and HTTPS URLs are presently supported
+ maxLength: 255
+ branch:
+ type: string
+ minLength: 1
+ maxLength: 64
+ token:
+ type: string
+ writeOnly: true
+ minLength: 1
+ username:
+ type: string
+ maxLength: 64
+ secrets_group:
+ allOf:
+ - $ref: '#/components/schemas/NestedSecretsGroupRequest'
+ 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'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ - name
+ - remote_url
+ BulkWritableGoldenConfigRequest:
+ type: object
+ description: Serializer for GoldenConfig object.
+ properties:
+ id:
+ type: string
+ format: uuid
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _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:
+ - device
+ - id
+ BulkWritableGoldenConfigSettingRequest:
+ type: object
+ description: Serializer for GoldenConfigSetting object.
+ properties:
+ id:
+ type: string
+ format: uuid
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ scope:
+ type: object
+ additionalProperties: {}
+ dynamic_group:
+ $ref: '#/components/schemas/NestedDynamicGroupRequest'
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ minLength: 1
+ 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.
+ 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:
+ - id
+ - name
+ - slug
+ BulkWritableGraphQLQueryRequest:
+ 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
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ query:
+ type: string
+ minLength: 1
+ variables:
+ type: object
+ additionalProperties: {}
+ nullable: true
+ default: {}
+ required:
+ - id
+ - name
+ - query
+ BulkWritableGroupRequest:
+ 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
+ name:
+ type: string
+ minLength: 1
+ maxLength: 150
+ required:
+ - id
+ - name
+ BulkWritableHardwareLCMRequest:
+ type: object
+ description: API serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ device_type:
+ allOf:
+ - $ref: '#/components/schemas/NestedDeviceTypeRequest'
+ 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/TagSerializerFieldRequest'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - device_type
+ - id
+ BulkWritableIPAddressRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ address:
+ type: string
+ minLength: 1
+ vrf:
+ allOf:
+ - $ref: '#/components/schemas/NestedVRFRequest'
+ nullable: true
+ tenant:
+ allOf:
+ - $ref: '#/components/schemas/NestedTenantRequest'
+ nullable: true
+ status:
+ $ref: '#/components/schemas/IPAddressStatusChoices'
+ role:
+ $ref: '#/components/schemas/RoleEnum'
+ assigned_object_type:
+ type: string
+ nullable: true
+ assigned_object_id:
+ type: string
+ format: uuid
+ nullable: true
+ nat_inside:
+ allOf:
+ - $ref: '#/components/schemas/NestedIPAddressRequest'
+ nullable: 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/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - address
+ - id
+ - status
+ BulkWritableIPRangeRequest:
+ type: object
+ description: IPRange Serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ start_address:
+ type: string
+ minLength: 1
+ end_address:
+ type: string
+ minLength: 1
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ vrf:
+ type: string
+ format: uuid
+ nullable: true
+ required:
+ - end_address
+ - id
+ - start_address
+ BulkWritableImageAttachmentRequest:
+ 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
+ content_type:
+ type: string
+ object_id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ maxLength: 50
+ image:
+ type: string
+ format: binary
+ image_height:
+ type: integer
+ maximum: 32767
+ minimum: 0
+ image_width:
+ type: integer
+ maximum: 32767
+ minimum: 0
+ required:
+ - content_type
+ - id
+ - image
+ - image_height
+ - image_width
+ - object_id
+ BulkWritableInterfaceRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ device:
+ $ref: '#/components/schemas/NestedDeviceRequest'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ label:
+ type: string
+ description: Physical label
+ maxLength: 64
+ status:
+ $ref: '#/components/schemas/InterfaceStatusChoices'
+ type:
+ $ref: '#/components/schemas/InterfaceTypeChoices'
+ enabled:
+ type: boolean
+ parent_interface:
+ allOf:
+ - $ref: '#/components/schemas/NestedInterfaceRequest'
+ nullable: true
+ bridge:
+ allOf:
+ - $ref: '#/components/schemas/NestedInterfaceRequest'
+ nullable: true
+ lag:
+ allOf:
+ - $ref: '#/components/schemas/NestedInterfaceRequest'
+ 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:
+ $ref: '#/components/schemas/ModeEnum'
+ untagged_vlan:
+ allOf:
+ - $ref: '#/components/schemas/NestedVLANRequest'
+ nullable: true
+ tagged_vlans:
+ type: array
+ items:
+ type: object
+ properties:
+ vid:
+ type: integer
+ maximum: 4094
+ minimum: 1
+ title: ID
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ required:
+ - name
+ - vid
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - device
+ - id
+ - name
+ - status
+ - type
+ BulkWritableInterfaceTemplateRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ device_type:
+ $ref: '#/components/schemas/NestedDeviceTypeRequest'
+ name:
+ type: string
+ minLength: 1
+ 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: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - device_type
+ - id
+ - name
+ - type
+ BulkWritableInventoryItemRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ device:
+ $ref: '#/components/schemas/NestedDeviceRequest'
+ parent:
+ type: string
+ format: uuid
+ nullable: true
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ label:
+ type: string
+ description: Physical label
+ maxLength: 64
+ manufacturer:
+ allOf:
+ - $ref: '#/components/schemas/NestedManufacturerRequest'
+ 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/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - device
+ - id
+ - name
+ BulkWritableJobHookRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ content_types:
+ type: array
+ items:
+ type: string
+ job:
+ type: string
+ format: uuid
+ description: The job that this job hook will initiate
+ enabled:
+ type: boolean
+ type_create:
+ type: boolean
+ description: Call this job hook when a matching object is created.
+ type_update:
+ type: boolean
+ description: Call this job hook when a matching object is updated.
+ type_delete:
+ type: boolean
+ description: Call this job hook when a matching object is deleted.
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - content_types
+ - id
+ - job
+ - name
+ BulkWritableJobRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ grouping:
+ type: string
+ minLength: 1
+ 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
+ minLength: 1
+ 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
+ enabled:
+ type: boolean
+ description: Whether this job can be executed by users
+ has_sensitive_variables:
+ type: boolean
+ description: Whether this job contains sensitive variables
+ has_sensitive_variables_override:
+ type: boolean
+ description: If set, the configured value will remain even if the underlying
+ Job source code changes
+ 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 SoftTimeLimitExceeded
+ exception.
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.
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
+ task_queues:
+ type: object
+ additionalProperties: {}
+ description: Comma separated list of task queues that this job can run on.
+ A blank list will use the default queue
+ task_queues_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/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - grouping
+ - id
+ - name
+ BulkWritableLocationRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ status:
+ $ref: '#/components/schemas/LocationStatusChoices'
+ location_type:
+ $ref: '#/components/schemas/NestedLocationTypeRequest'
+ parent:
+ allOf:
+ - $ref: '#/components/schemas/NestedLocationRequest'
+ nullable: true
+ site:
+ allOf:
+ - $ref: '#/components/schemas/NestedSiteRequest'
+ nullable: true
+ tenant:
+ allOf:
+ - $ref: '#/components/schemas/NestedTenantRequest'
+ nullable: true
+ description:
+ type: string
+ maxLength: 200
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ - location_type
+ - name
+ - status
+ BulkWritableLocationTypeRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ parent:
+ allOf:
+ - $ref: '#/components/schemas/NestedLocationTypeRequest'
+ nullable: true
+ nestable:
+ type: boolean
+ description: Allow Locations of this type to be parents/children of other
+ Locations of this same type
+ content_types:
+ type: array
+ items:
+ type: string
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ - name
+ BulkWritableManufacturerRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ - name
+ BulkWritableMinMaxValidationRuleRequest:
+ type: object
+ description: Serializer for `MinMaxValidationRule` objects.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ minLength: 1
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ content_type:
+ type: string
+ field:
+ type: string
+ minLength: 1
+ 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
+ required:
+ - content_type
+ - field
+ - id
+ - name
+ - slug
+ BulkWritableNATPolicyRequest:
+ type: object
+ description: NATPolicy Serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ assigned_devices:
+ type: array
+ items:
+ $ref: '#/components/schemas/NATPolicyDeviceM2MNestedRequest'
+ assigned_dynamic_groups:
+ type: array
+ items:
+ $ref: '#/components/schemas/NATPolicyDynamicGroupM2MNestedRequest'
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ tenant:
+ type: string
+ format: uuid
+ nullable: true
+ required:
+ - id
+ - name
+ BulkWritableNATPolicyRuleRequest:
+ type: object
+ description: PolicyRule Serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ source_zone:
+ $ref: '#/components/schemas/ZoneRequest'
+ destination_zone:
+ $ref: '#/components/schemas/ZoneRequest'
+ original_source_addresses:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ ip_range:
+ $ref: '#/components/schemas/NestedIPRangeRequest'
+ fqdn:
+ $ref: '#/components/schemas/NestedFQDNRequest'
+ ip_address:
+ $ref: '#/components/schemas/NestedIPAddressRequest'
+ prefix:
+ $ref: '#/components/schemas/NestedPrefixRequest'
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name descriptor for an address object type.
+ maxLength: 100
+ required:
+ - name
+ original_source_address_groups:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ address_objects:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ ip_range:
+ $ref: '#/components/schemas/NestedIPRangeRequest'
+ fqdn:
+ $ref: '#/components/schemas/NestedFQDNRequest'
+ ip_address:
+ $ref: '#/components/schemas/NestedIPAddressRequest'
+ prefix:
+ $ref: '#/components/schemas/NestedPrefixRequest'
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name descriptor for an address object type.
+ maxLength: 100
+ required:
+ - name
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name descriptor for a group address objects.
+ maxLength: 100
+ required:
+ - name
+ original_source_services:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name of the service (e.g. HTTP)
+ maxLength: 100
+ port:
+ type: string
+ nullable: true
+ description: The port or port range to tie to a service (e.g. HTTP
+ would be port 80)
+ maxLength: 20
+ ip_protocol:
+ enum:
+ - ICMP
+ - IGMP
+ - GGP
+ - TCP
+ - CBT
+ - EGP
+ - IGP
+ - BBN-RCC-MON
+ - NVP-II
+ - PUP
+ - EMCON
+ - XNET
+ - CHAOS
+ - UDP
+ - MUX
+ - DCN-MEAS
+ - HMP
+ - PRM
+ - XNS-IDP
+ - TRUNK-1
+ - TRUNK-2
+ - LEAF-1
+ - LEAF-2
+ - RDP
+ - IRTP
+ - ISO-TP4
+ - NETBLT
+ - MFE-NSP
+ - MERIT-INP
+ - DCCP
+ - 3PC
+ - IDPR
+ - XTP
+ - DDP
+ - IDPR-CMTP
+ - TP++
+ - IL
+ - SDRP
+ - IDRP
+ - RSVP
+ - GRE
+ - DSR
+ - BNA
+ - ESP
+ - AH
+ - I-NLSP
+ - NARP
+ - MOBILE
+ - TLSP
+ - SKIP
+ - CFTP
+ - SAT-EXPAK
+ - KRYPTOLAN
+ - RVD
+ - IPPC
+ - SAT-MON
+ - VISA
+ - IPCV
+ - CPNX
+ - CPHB
+ - WSN
+ - PVP
+ - BR-SAT-MON
+ - SUN-ND
+ - WB-MON
+ - WB-EXPAK
+ - ISO-IP
+ - VMTP
+ - SECURE-VMTP
+ - VINES
+ - TTP
+ - NSFNET-IGP
+ - DGP
+ - TCF
+ - EIGRP
+ - OSPFIGP
+ - Sprite-RPC
+ - LARP
+ - MTP
+ - AX.25
+ - IPIP
+ - SCC-SP
+ - ETHERIP
+ - ENCAP
+ - GMTP
+ - IFMP
+ - PNNI
+ - PIM
+ - ARIS
+ - SCPS
+ - QNX
+ - A/N
+ - IPComp
+ - SNP
+ - Compaq-Peer
+ - IPX-in-IP
+ - PGM
+ - L2TP
+ - DDX
+ - IATP
+ - STP
+ - SRP
+ - UTI
+ - SMP
+ - SM
+ - PTP
+ - FIRE
+ - CRTP
+ - CRUDP
+ - SSCOPMCE
+ - IPLT
+ - SPS
+ - PIPE
+ - SCTP
+ - FC
+ - RSVP-E2E-IGNORE
+ - UDPLite
+ - manet
+ - HIP
+ - WESP
+ - ROHC
+ - Ethernet
+ type: string
+ description: IANA IP Protocol (e.g. TCP UDP ICMP)
+ required:
+ - ip_protocol
+ - name
+ original_source_service_groups:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ service_objects:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name of the service (e.g. HTTP)
+ maxLength: 100
+ port:
+ type: string
+ nullable: true
+ description: The port or port range to tie to a service (e.g.
+ HTTP would be port 80)
+ maxLength: 20
+ ip_protocol:
+ enum:
+ - ICMP
+ - IGMP
+ - GGP
+ - TCP
+ - CBT
+ - EGP
+ - IGP
+ - BBN-RCC-MON
+ - NVP-II
+ - PUP
+ - EMCON
+ - XNET
+ - CHAOS
+ - UDP
+ - MUX
+ - DCN-MEAS
+ - HMP
+ - PRM
+ - XNS-IDP
+ - TRUNK-1
+ - TRUNK-2
+ - LEAF-1
+ - LEAF-2
+ - RDP
+ - IRTP
+ - ISO-TP4
+ - NETBLT
+ - MFE-NSP
+ - MERIT-INP
+ - DCCP
+ - 3PC
+ - IDPR
+ - XTP
+ - DDP
+ - IDPR-CMTP
+ - TP++
+ - IL
+ - SDRP
+ - IDRP
+ - RSVP
+ - GRE
+ - DSR
+ - BNA
+ - ESP
+ - AH
+ - I-NLSP
+ - NARP
+ - MOBILE
+ - TLSP
+ - SKIP
+ - CFTP
+ - SAT-EXPAK
+ - KRYPTOLAN
+ - RVD
+ - IPPC
+ - SAT-MON
+ - VISA
+ - IPCV
+ - CPNX
+ - CPHB
+ - WSN
+ - PVP
+ - BR-SAT-MON
+ - SUN-ND
+ - WB-MON
+ - WB-EXPAK
+ - ISO-IP
+ - VMTP
+ - SECURE-VMTP
+ - VINES
+ - TTP
+ - NSFNET-IGP
+ - DGP
+ - TCF
+ - EIGRP
+ - OSPFIGP
+ - Sprite-RPC
+ - LARP
+ - MTP
+ - AX.25
+ - IPIP
+ - SCC-SP
+ - ETHERIP
+ - ENCAP
+ - GMTP
+ - IFMP
+ - PNNI
+ - PIM
+ - ARIS
+ - SCPS
+ - QNX
+ - A/N
+ - IPComp
+ - SNP
+ - Compaq-Peer
+ - IPX-in-IP
+ - PGM
+ - L2TP
+ - DDX
+ - IATP
+ - STP
+ - SRP
+ - UTI
+ - SMP
+ - SM
+ - PTP
+ - FIRE
+ - CRTP
+ - CRUDP
+ - SSCOPMCE
+ - IPLT
+ - SPS
+ - PIPE
+ - SCTP
+ - FC
+ - RSVP-E2E-IGNORE
+ - UDPLite
+ - manet
+ - HIP
+ - WESP
+ - ROHC
+ - Ethernet
+ type: string
+ description: IANA IP Protocol (e.g. TCP UDP ICMP)
+ required:
+ - ip_protocol
+ - name
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ required:
+ - name
+ translated_source_addresses:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ ip_range:
+ $ref: '#/components/schemas/NestedIPRangeRequest'
+ fqdn:
+ $ref: '#/components/schemas/NestedFQDNRequest'
+ ip_address:
+ $ref: '#/components/schemas/NestedIPAddressRequest'
+ prefix:
+ $ref: '#/components/schemas/NestedPrefixRequest'
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name descriptor for an address object type.
+ maxLength: 100
+ required:
+ - name
+ translated_source_address_groups:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ address_objects:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ ip_range:
+ $ref: '#/components/schemas/NestedIPRangeRequest'
+ fqdn:
+ $ref: '#/components/schemas/NestedFQDNRequest'
+ ip_address:
+ $ref: '#/components/schemas/NestedIPAddressRequest'
+ prefix:
+ $ref: '#/components/schemas/NestedPrefixRequest'
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name descriptor for an address object type.
+ maxLength: 100
+ required:
+ - name
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name descriptor for a group address objects.
+ maxLength: 100
+ required:
+ - name
+ translated_source_services:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name of the service (e.g. HTTP)
+ maxLength: 100
+ port:
+ type: string
+ nullable: true
+ description: The port or port range to tie to a service (e.g. HTTP
+ would be port 80)
+ maxLength: 20
+ ip_protocol:
+ enum:
+ - ICMP
+ - IGMP
+ - GGP
+ - TCP
+ - CBT
+ - EGP
+ - IGP
+ - BBN-RCC-MON
+ - NVP-II
+ - PUP
+ - EMCON
+ - XNET
+ - CHAOS
+ - UDP
+ - MUX
+ - DCN-MEAS
+ - HMP
+ - PRM
+ - XNS-IDP
+ - TRUNK-1
+ - TRUNK-2
+ - LEAF-1
+ - LEAF-2
+ - RDP
+ - IRTP
+ - ISO-TP4
+ - NETBLT
+ - MFE-NSP
+ - MERIT-INP
+ - DCCP
+ - 3PC
+ - IDPR
+ - XTP
+ - DDP
+ - IDPR-CMTP
+ - TP++
+ - IL
+ - SDRP
+ - IDRP
+ - RSVP
+ - GRE
+ - DSR
+ - BNA
+ - ESP
+ - AH
+ - I-NLSP
+ - NARP
+ - MOBILE
+ - TLSP
+ - SKIP
+ - CFTP
+ - SAT-EXPAK
+ - KRYPTOLAN
+ - RVD
+ - IPPC
+ - SAT-MON
+ - VISA
+ - IPCV
+ - CPNX
+ - CPHB
+ - WSN
+ - PVP
+ - BR-SAT-MON
+ - SUN-ND
+ - WB-MON
+ - WB-EXPAK
+ - ISO-IP
+ - VMTP
+ - SECURE-VMTP
+ - VINES
+ - TTP
+ - NSFNET-IGP
+ - DGP
+ - TCF
+ - EIGRP
+ - OSPFIGP
+ - Sprite-RPC
+ - LARP
+ - MTP
+ - AX.25
+ - IPIP
+ - SCC-SP
+ - ETHERIP
+ - ENCAP
+ - GMTP
+ - IFMP
+ - PNNI
+ - PIM
+ - ARIS
+ - SCPS
+ - QNX
+ - A/N
+ - IPComp
+ - SNP
+ - Compaq-Peer
+ - IPX-in-IP
+ - PGM
+ - L2TP
+ - DDX
+ - IATP
+ - STP
+ - SRP
+ - UTI
+ - SMP
+ - SM
+ - PTP
+ - FIRE
+ - CRTP
+ - CRUDP
+ - SSCOPMCE
+ - IPLT
+ - SPS
+ - PIPE
+ - SCTP
+ - FC
+ - RSVP-E2E-IGNORE
+ - UDPLite
+ - manet
+ - HIP
+ - WESP
+ - ROHC
+ - Ethernet
+ type: string
+ description: IANA IP Protocol (e.g. TCP UDP ICMP)
+ required:
+ - ip_protocol
+ - name
+ translated_source_service_groups:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ service_objects:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name of the service (e.g. HTTP)
+ maxLength: 100
+ port:
+ type: string
+ nullable: true
+ description: The port or port range to tie to a service (e.g.
+ HTTP would be port 80)
+ maxLength: 20
+ ip_protocol:
+ enum:
+ - ICMP
+ - IGMP
+ - GGP
+ - TCP
+ - CBT
+ - EGP
+ - IGP
+ - BBN-RCC-MON
+ - NVP-II
+ - PUP
+ - EMCON
+ - XNET
+ - CHAOS
+ - UDP
+ - MUX
+ - DCN-MEAS
+ - HMP
+ - PRM
+ - XNS-IDP
+ - TRUNK-1
+ - TRUNK-2
+ - LEAF-1
+ - LEAF-2
+ - RDP
+ - IRTP
+ - ISO-TP4
+ - NETBLT
+ - MFE-NSP
+ - MERIT-INP
+ - DCCP
+ - 3PC
+ - IDPR
+ - XTP
+ - DDP
+ - IDPR-CMTP
+ - TP++
+ - IL
+ - SDRP
+ - IDRP
+ - RSVP
+ - GRE
+ - DSR
+ - BNA
+ - ESP
+ - AH
+ - I-NLSP
+ - NARP
+ - MOBILE
+ - TLSP
+ - SKIP
+ - CFTP
+ - SAT-EXPAK
+ - KRYPTOLAN
+ - RVD
+ - IPPC
+ - SAT-MON
+ - VISA
+ - IPCV
+ - CPNX
+ - CPHB
+ - WSN
+ - PVP
+ - BR-SAT-MON
+ - SUN-ND
+ - WB-MON
+ - WB-EXPAK
+ - ISO-IP
+ - VMTP
+ - SECURE-VMTP
+ - VINES
+ - TTP
+ - NSFNET-IGP
+ - DGP
+ - TCF
+ - EIGRP
+ - OSPFIGP
+ - Sprite-RPC
+ - LARP
+ - MTP
+ - AX.25
+ - IPIP
+ - SCC-SP
+ - ETHERIP
+ - ENCAP
+ - GMTP
+ - IFMP
+ - PNNI
+ - PIM
+ - ARIS
+ - SCPS
+ - QNX
+ - A/N
+ - IPComp
+ - SNP
+ - Compaq-Peer
+ - IPX-in-IP
+ - PGM
+ - L2TP
+ - DDX
+ - IATP
+ - STP
+ - SRP
+ - UTI
+ - SMP
+ - SM
+ - PTP
+ - FIRE
+ - CRTP
+ - CRUDP
+ - SSCOPMCE
+ - IPLT
+ - SPS
+ - PIPE
+ - SCTP
+ - FC
+ - RSVP-E2E-IGNORE
+ - UDPLite
+ - manet
+ - HIP
+ - WESP
+ - ROHC
+ - Ethernet
+ type: string
+ description: IANA IP Protocol (e.g. TCP UDP ICMP)
+ required:
+ - ip_protocol
+ - name
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ required:
+ - name
+ original_destination_addresses:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ ip_range:
+ $ref: '#/components/schemas/NestedIPRangeRequest'
+ fqdn:
+ $ref: '#/components/schemas/NestedFQDNRequest'
+ ip_address:
+ $ref: '#/components/schemas/NestedIPAddressRequest'
+ prefix:
+ $ref: '#/components/schemas/NestedPrefixRequest'
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name descriptor for an address object type.
+ maxLength: 100
+ required:
+ - name
+ original_destination_address_groups:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ address_objects:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ ip_range:
+ $ref: '#/components/schemas/NestedIPRangeRequest'
+ fqdn:
+ $ref: '#/components/schemas/NestedFQDNRequest'
+ ip_address:
+ $ref: '#/components/schemas/NestedIPAddressRequest'
+ prefix:
+ $ref: '#/components/schemas/NestedPrefixRequest'
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name descriptor for an address object type.
+ maxLength: 100
+ required:
+ - name
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name descriptor for a group address objects.
+ maxLength: 100
+ required:
+ - name
+ original_destination_services:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name of the service (e.g. HTTP)
+ maxLength: 100
+ port:
+ type: string
+ nullable: true
+ description: The port or port range to tie to a service (e.g. HTTP
+ would be port 80)
+ maxLength: 20
+ ip_protocol:
+ enum:
+ - ICMP
+ - IGMP
+ - GGP
+ - TCP
+ - CBT
+ - EGP
+ - IGP
+ - BBN-RCC-MON
+ - NVP-II
+ - PUP
+ - EMCON
+ - XNET
+ - CHAOS
+ - UDP
+ - MUX
+ - DCN-MEAS
+ - HMP
+ - PRM
+ - XNS-IDP
+ - TRUNK-1
+ - TRUNK-2
+ - LEAF-1
+ - LEAF-2
+ - RDP
+ - IRTP
+ - ISO-TP4
+ - NETBLT
+ - MFE-NSP
+ - MERIT-INP
+ - DCCP
+ - 3PC
+ - IDPR
+ - XTP
+ - DDP
+ - IDPR-CMTP
+ - TP++
+ - IL
+ - SDRP
+ - IDRP
+ - RSVP
+ - GRE
+ - DSR
+ - BNA
+ - ESP
+ - AH
+ - I-NLSP
+ - NARP
+ - MOBILE
+ - TLSP
+ - SKIP
+ - CFTP
+ - SAT-EXPAK
+ - KRYPTOLAN
+ - RVD
+ - IPPC
+ - SAT-MON
+ - VISA
+ - IPCV
+ - CPNX
+ - CPHB
+ - WSN
+ - PVP
+ - BR-SAT-MON
+ - SUN-ND
+ - WB-MON
+ - WB-EXPAK
+ - ISO-IP
+ - VMTP
+ - SECURE-VMTP
+ - VINES
+ - TTP
+ - NSFNET-IGP
+ - DGP
+ - TCF
+ - EIGRP
+ - OSPFIGP
+ - Sprite-RPC
+ - LARP
+ - MTP
+ - AX.25
+ - IPIP
+ - SCC-SP
+ - ETHERIP
+ - ENCAP
+ - GMTP
+ - IFMP
+ - PNNI
+ - PIM
+ - ARIS
+ - SCPS
+ - QNX
+ - A/N
+ - IPComp
+ - SNP
+ - Compaq-Peer
+ - IPX-in-IP
+ - PGM
+ - L2TP
+ - DDX
+ - IATP
+ - STP
+ - SRP
+ - UTI
+ - SMP
+ - SM
+ - PTP
+ - FIRE
+ - CRTP
+ - CRUDP
+ - SSCOPMCE
+ - IPLT
+ - SPS
+ - PIPE
+ - SCTP
+ - FC
+ - RSVP-E2E-IGNORE
+ - UDPLite
+ - manet
+ - HIP
+ - WESP
+ - ROHC
+ - Ethernet
+ type: string
+ description: IANA IP Protocol (e.g. TCP UDP ICMP)
+ required:
+ - ip_protocol
+ - name
+ original_destination_service_groups:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ service_objects:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name of the service (e.g. HTTP)
+ maxLength: 100
+ port:
+ type: string
+ nullable: true
+ description: The port or port range to tie to a service (e.g.
+ HTTP would be port 80)
+ maxLength: 20
+ ip_protocol:
+ enum:
+ - ICMP
+ - IGMP
+ - GGP
+ - TCP
+ - CBT
+ - EGP
+ - IGP
+ - BBN-RCC-MON
+ - NVP-II
+ - PUP
+ - EMCON
+ - XNET
+ - CHAOS
+ - UDP
+ - MUX
+ - DCN-MEAS
+ - HMP
+ - PRM
+ - XNS-IDP
+ - TRUNK-1
+ - TRUNK-2
+ - LEAF-1
+ - LEAF-2
+ - RDP
+ - IRTP
+ - ISO-TP4
+ - NETBLT
+ - MFE-NSP
+ - MERIT-INP
+ - DCCP
+ - 3PC
+ - IDPR
+ - XTP
+ - DDP
+ - IDPR-CMTP
+ - TP++
+ - IL
+ - SDRP
+ - IDRP
+ - RSVP
+ - GRE
+ - DSR
+ - BNA
+ - ESP
+ - AH
+ - I-NLSP
+ - NARP
+ - MOBILE
+ - TLSP
+ - SKIP
+ - CFTP
+ - SAT-EXPAK
+ - KRYPTOLAN
+ - RVD
+ - IPPC
+ - SAT-MON
+ - VISA
+ - IPCV
+ - CPNX
+ - CPHB
+ - WSN
+ - PVP
+ - BR-SAT-MON
+ - SUN-ND
+ - WB-MON
+ - WB-EXPAK
+ - ISO-IP
+ - VMTP
+ - SECURE-VMTP
+ - VINES
+ - TTP
+ - NSFNET-IGP
+ - DGP
+ - TCF
+ - EIGRP
+ - OSPFIGP
+ - Sprite-RPC
+ - LARP
+ - MTP
+ - AX.25
+ - IPIP
+ - SCC-SP
+ - ETHERIP
+ - ENCAP
+ - GMTP
+ - IFMP
+ - PNNI
+ - PIM
+ - ARIS
+ - SCPS
+ - QNX
+ - A/N
+ - IPComp
+ - SNP
+ - Compaq-Peer
+ - IPX-in-IP
+ - PGM
+ - L2TP
+ - DDX
+ - IATP
+ - STP
+ - SRP
+ - UTI
+ - SMP
+ - SM
+ - PTP
+ - FIRE
+ - CRTP
+ - CRUDP
+ - SSCOPMCE
+ - IPLT
+ - SPS
+ - PIPE
+ - SCTP
+ - FC
+ - RSVP-E2E-IGNORE
+ - UDPLite
+ - manet
+ - HIP
+ - WESP
+ - ROHC
+ - Ethernet
+ type: string
+ description: IANA IP Protocol (e.g. TCP UDP ICMP)
+ required:
+ - ip_protocol
+ - name
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ required:
+ - name
+ translated_destination_addresses:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ ip_range:
+ $ref: '#/components/schemas/NestedIPRangeRequest'
+ fqdn:
+ $ref: '#/components/schemas/NestedFQDNRequest'
+ ip_address:
+ $ref: '#/components/schemas/NestedIPAddressRequest'
+ prefix:
+ $ref: '#/components/schemas/NestedPrefixRequest'
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name descriptor for an address object type.
+ maxLength: 100
+ required:
+ - name
+ translated_destination_address_groups:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ address_objects:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ ip_range:
+ $ref: '#/components/schemas/NestedIPRangeRequest'
+ fqdn:
+ $ref: '#/components/schemas/NestedFQDNRequest'
+ ip_address:
+ $ref: '#/components/schemas/NestedIPAddressRequest'
+ prefix:
+ $ref: '#/components/schemas/NestedPrefixRequest'
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name descriptor for an address object type.
+ maxLength: 100
+ required:
+ - name
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name descriptor for a group address objects.
+ maxLength: 100
+ required:
+ - name
+ translated_destination_services:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name of the service (e.g. HTTP)
+ maxLength: 100
+ port:
+ type: string
+ nullable: true
+ description: The port or port range to tie to a service (e.g. HTTP
+ would be port 80)
+ maxLength: 20
+ ip_protocol:
+ enum:
+ - ICMP
+ - IGMP
+ - GGP
+ - TCP
+ - CBT
+ - EGP
+ - IGP
+ - BBN-RCC-MON
+ - NVP-II
+ - PUP
+ - EMCON
+ - XNET
+ - CHAOS
+ - UDP
+ - MUX
+ - DCN-MEAS
+ - HMP
+ - PRM
+ - XNS-IDP
+ - TRUNK-1
+ - TRUNK-2
+ - LEAF-1
+ - LEAF-2
+ - RDP
+ - IRTP
+ - ISO-TP4
+ - NETBLT
+ - MFE-NSP
+ - MERIT-INP
+ - DCCP
+ - 3PC
+ - IDPR
+ - XTP
+ - DDP
+ - IDPR-CMTP
+ - TP++
+ - IL
+ - SDRP
+ - IDRP
+ - RSVP
+ - GRE
+ - DSR
+ - BNA
+ - ESP
+ - AH
+ - I-NLSP
+ - NARP
+ - MOBILE
+ - TLSP
+ - SKIP
+ - CFTP
+ - SAT-EXPAK
+ - KRYPTOLAN
+ - RVD
+ - IPPC
+ - SAT-MON
+ - VISA
+ - IPCV
+ - CPNX
+ - CPHB
+ - WSN
+ - PVP
+ - BR-SAT-MON
+ - SUN-ND
+ - WB-MON
+ - WB-EXPAK
+ - ISO-IP
+ - VMTP
+ - SECURE-VMTP
+ - VINES
+ - TTP
+ - NSFNET-IGP
+ - DGP
+ - TCF
+ - EIGRP
+ - OSPFIGP
+ - Sprite-RPC
+ - LARP
+ - MTP
+ - AX.25
+ - IPIP
+ - SCC-SP
+ - ETHERIP
+ - ENCAP
+ - GMTP
+ - IFMP
+ - PNNI
+ - PIM
+ - ARIS
+ - SCPS
+ - QNX
+ - A/N
+ - IPComp
+ - SNP
+ - Compaq-Peer
+ - IPX-in-IP
+ - PGM
+ - L2TP
+ - DDX
+ - IATP
+ - STP
+ - SRP
+ - UTI
+ - SMP
+ - SM
+ - PTP
+ - FIRE
+ - CRTP
+ - CRUDP
+ - SSCOPMCE
+ - IPLT
+ - SPS
+ - PIPE
+ - SCTP
+ - FC
+ - RSVP-E2E-IGNORE
+ - UDPLite
+ - manet
+ - HIP
+ - WESP
+ - ROHC
+ - Ethernet
+ type: string
+ description: IANA IP Protocol (e.g. TCP UDP ICMP)
+ required:
+ - ip_protocol
+ - name
+ translated_destination_service_groups:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ service_objects:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name of the service (e.g. HTTP)
+ maxLength: 100
+ port:
+ type: string
+ nullable: true
+ description: The port or port range to tie to a service (e.g.
+ HTTP would be port 80)
+ maxLength: 20
+ ip_protocol:
+ enum:
+ - ICMP
+ - IGMP
+ - GGP
+ - TCP
+ - CBT
+ - EGP
+ - IGP
+ - BBN-RCC-MON
+ - NVP-II
+ - PUP
+ - EMCON
+ - XNET
+ - CHAOS
+ - UDP
+ - MUX
+ - DCN-MEAS
+ - HMP
+ - PRM
+ - XNS-IDP
+ - TRUNK-1
+ - TRUNK-2
+ - LEAF-1
+ - LEAF-2
+ - RDP
+ - IRTP
+ - ISO-TP4
+ - NETBLT
+ - MFE-NSP
+ - MERIT-INP
+ - DCCP
+ - 3PC
+ - IDPR
+ - XTP
+ - DDP
+ - IDPR-CMTP
+ - TP++
+ - IL
+ - SDRP
+ - IDRP
+ - RSVP
+ - GRE
+ - DSR
+ - BNA
+ - ESP
+ - AH
+ - I-NLSP
+ - NARP
+ - MOBILE
+ - TLSP
+ - SKIP
+ - CFTP
+ - SAT-EXPAK
+ - KRYPTOLAN
+ - RVD
+ - IPPC
+ - SAT-MON
+ - VISA
+ - IPCV
+ - CPNX
+ - CPHB
+ - WSN
+ - PVP
+ - BR-SAT-MON
+ - SUN-ND
+ - WB-MON
+ - WB-EXPAK
+ - ISO-IP
+ - VMTP
+ - SECURE-VMTP
+ - VINES
+ - TTP
+ - NSFNET-IGP
+ - DGP
+ - TCF
+ - EIGRP
+ - OSPFIGP
+ - Sprite-RPC
+ - LARP
+ - MTP
+ - AX.25
+ - IPIP
+ - SCC-SP
+ - ETHERIP
+ - ENCAP
+ - GMTP
+ - IFMP
+ - PNNI
+ - PIM
+ - ARIS
+ - SCPS
+ - QNX
+ - A/N
+ - IPComp
+ - SNP
+ - Compaq-Peer
+ - IPX-in-IP
+ - PGM
+ - L2TP
+ - DDX
+ - IATP
+ - STP
+ - SRP
+ - UTI
+ - SMP
+ - SM
+ - PTP
+ - FIRE
+ - CRTP
+ - CRUDP
+ - SSCOPMCE
+ - IPLT
+ - SPS
+ - PIPE
+ - SCTP
+ - FC
+ - RSVP-E2E-IGNORE
+ - UDPLite
+ - manet
+ - HIP
+ - WESP
+ - ROHC
+ - Ethernet
+ type: string
+ description: IANA IP Protocol (e.g. TCP UDP ICMP)
+ required:
+ - ip_protocol
+ - name
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ required:
+ - name
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ remark:
+ type: boolean
+ log:
+ type: boolean
+ request_id:
+ type: string
+ nullable: true
+ maxLength: 100
+ description:
+ type: string
+ nullable: true
+ maxLength: 200
+ index:
+ type: integer
+ maximum: 32767
+ minimum: 0
+ nullable: true
+ required:
+ - id
+ - name
+ BulkWritableNoteRequest:
+ 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.
+ - ensures that `id` field is always present on the serializer as well
+ - ensures that `created` and `last_updated` fields are always present if applicable to this model and serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ assigned_object_type:
+ type: string
+ assigned_object_id:
+ type: string
+ format: uuid
+ note:
+ type: string
+ minLength: 1
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ required:
+ - assigned_object_id
+ - assigned_object_type
+ - id
+ - note
+ BulkWritableObjectPermissionRequest:
+ 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
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ description:
+ type: string
+ maxLength: 200
+ enabled:
+ type: boolean
+ object_types:
+ type: array
+ items:
+ type: string
+ groups:
+ type: array
+ items:
+ type: object
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 150
+ required:
+ - name
+ users:
+ type: array
+ items:
+ type: object
+ properties:
+ username:
+ type: string
+ minLength: 1
+ description: Required. 150 characters or fewer. Letters, digits and
+ @/./+/-/_ only.
+ pattern: ^[\w.@+-]+$
+ maxLength: 150
+ required:
+ - 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)
+ required:
+ - actions
+ - id
+ - name
+ - object_types
+ BulkWritablePeerEndpointRequest:
+ type: object
+ description: REST API serializer for PeerEndpoint records.
+ properties:
+ id:
+ type: string
+ format: uuid
+ source_ip:
+ allOf:
+ - $ref: '#/components/schemas/NestedIPAddressRequest'
+ nullable: true
+ source_interface:
+ allOf:
+ - $ref: '#/components/schemas/NestedInterfaceRequest'
+ nullable: true
+ autonomous_system:
+ allOf:
+ - $ref: '#/components/schemas/NestedAutonomousSystemRequest'
+ nullable: true
+ peer_group:
+ allOf:
+ - $ref: '#/components/schemas/NestedPeerGroupRequest'
+ nullable: true
+ import_policy:
+ type: string
+ maxLength: 100
+ export_policy:
+ type: string
+ maxLength: 100
+ peering:
+ allOf:
+ - $ref: '#/components/schemas/NestedPeeringRequest'
+ nullable: true
+ secret:
+ allOf:
+ - $ref: '#/components/schemas/NestedSecretRequest'
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ enabled:
+ type: boolean
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - id
+ - peering
+ BulkWritablePeerGroupRequest:
+ type: object
+ description: REST API serializer for PeerGroup records.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ source_ip:
+ allOf:
+ - $ref: '#/components/schemas/NestedIPAddressRequest'
+ nullable: true
+ source_interface:
+ allOf:
+ - $ref: '#/components/schemas/NestedInterfaceRequest'
+ nullable: true
+ description:
+ type: string
+ maxLength: 200
+ enabled:
+ type: boolean
+ autonomous_system:
+ allOf:
+ - $ref: '#/components/schemas/NestedAutonomousSystemRequest'
+ nullable: true
+ template:
+ allOf:
+ - $ref: '#/components/schemas/NestedPeerGroupTemplateRequest'
+ nullable: true
+ secret:
+ allOf:
+ - $ref: '#/components/schemas/NestedSecretRequest'
+ nullable: true
+ role:
+ type: string
+ format: uuid
+ nullable: true
+ import_policy:
+ type: string
+ maxLength: 100
+ export_policy:
+ type: string
+ maxLength: 100
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - id
+ - name
+ BulkWritablePeerGroupTemplateRequest:
+ type: object
+ description: REST API serializer for PeerGroup records.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ role:
+ type: string
+ format: uuid
+ nullable: true
+ description:
+ type: string
+ maxLength: 200
+ enabled:
+ type: boolean
+ autonomous_system:
+ allOf:
+ - $ref: '#/components/schemas/NestedAutonomousSystemRequest'
+ nullable: true
+ import_policy:
+ type: string
+ maxLength: 100
+ export_policy:
+ type: string
+ maxLength: 100
+ secret:
+ allOf:
+ - $ref: '#/components/schemas/NestedSecretRequest'
+ nullable: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - id
+ - name
+ BulkWritablePeeringRequest:
+ type: object
+ description: REST API serializer for Peering records.
+ properties:
+ id:
+ type: string
+ format: uuid
+ status:
+ $ref: '#/components/schemas/CircuitStatusChoices'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - id
+ - status
+ BulkWritablePeeringRoleRequest:
+ type: object
+ description: REST API serializer for PeeringRole records.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ color:
+ type: string
+ minLength: 1
+ pattern: ^[0-9a-f]{6}$
+ maxLength: 6
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - id
+ - name
+ BulkWritablePlatformRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ manufacturer:
+ allOf:
+ - $ref: '#/components/schemas/NestedManufacturerRequest'
+ 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
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ - name
+ BulkWritablePolicyRequest:
+ type: object
+ description: Policy Serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ assigned_devices:
+ type: array
+ items:
+ $ref: '#/components/schemas/PolicyDeviceM2MNestedRequest'
+ assigned_dynamic_groups:
+ type: array
+ items:
+ $ref: '#/components/schemas/PolicyDynamicGroupM2MNestedRequest'
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ tenant:
+ type: string
+ format: uuid
+ nullable: true
+ required:
+ - id
+ - name
+ BulkWritablePolicyRuleRequest:
+ type: object
+ description: PolicyRule Serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ source_users:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ username:
+ type: string
+ minLength: 1
+ description: Signifies the username in identify provider (e.g. john.smith)
+ maxLength: 100
+ name:
+ type: string
+ description: Signifies the name of the user, commonly first & last
+ name (e.g. John Smith)
+ maxLength: 100
+ required:
+ - username
+ source_user_groups:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ user_objects:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ username:
+ type: string
+ minLength: 1
+ description: Signifies the username in identify provider (e.g.
+ john.smith)
+ maxLength: 100
+ name:
+ type: string
+ description: Signifies the name of the user, commonly first
+ & last name (e.g. John Smith)
+ maxLength: 100
+ required:
+ - username
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ required:
+ - name
+ source_addresses:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ ip_range:
+ $ref: '#/components/schemas/NestedIPRangeRequest'
+ fqdn:
+ $ref: '#/components/schemas/NestedFQDNRequest'
+ ip_address:
+ $ref: '#/components/schemas/NestedIPAddressRequest'
+ prefix:
+ $ref: '#/components/schemas/NestedPrefixRequest'
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name descriptor for an address object type.
+ maxLength: 100
+ required:
+ - name
+ source_address_groups:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ address_objects:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ ip_range:
+ $ref: '#/components/schemas/NestedIPRangeRequest'
+ fqdn:
+ $ref: '#/components/schemas/NestedFQDNRequest'
+ ip_address:
+ $ref: '#/components/schemas/NestedIPAddressRequest'
+ prefix:
+ $ref: '#/components/schemas/NestedPrefixRequest'
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name descriptor for an address object type.
+ maxLength: 100
+ required:
+ - name
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name descriptor for a group address objects.
+ maxLength: 100
+ required:
+ - name
+ source_zone:
+ $ref: '#/components/schemas/ZoneRequest'
+ destination_addresses:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ ip_range:
+ $ref: '#/components/schemas/NestedIPRangeRequest'
+ fqdn:
+ $ref: '#/components/schemas/NestedFQDNRequest'
+ ip_address:
+ $ref: '#/components/schemas/NestedIPAddressRequest'
+ prefix:
+ $ref: '#/components/schemas/NestedPrefixRequest'
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name descriptor for an address object type.
+ maxLength: 100
+ required:
+ - name
+ destination_address_groups:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ address_objects:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ ip_range:
+ $ref: '#/components/schemas/NestedIPRangeRequest'
+ fqdn:
+ $ref: '#/components/schemas/NestedFQDNRequest'
+ ip_address:
+ $ref: '#/components/schemas/NestedIPAddressRequest'
+ prefix:
+ $ref: '#/components/schemas/NestedPrefixRequest'
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name descriptor for an address object type.
+ maxLength: 100
+ required:
+ - name
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name descriptor for a group address objects.
+ maxLength: 100
+ required:
+ - name
+ destination_zone:
+ $ref: '#/components/schemas/ZoneRequest'
+ destination_services:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name of the service (e.g. HTTP)
+ maxLength: 100
+ port:
+ type: string
+ nullable: true
+ description: The port or port range to tie to a service (e.g. HTTP
+ would be port 80)
+ maxLength: 20
+ ip_protocol:
+ enum:
+ - ICMP
+ - IGMP
+ - GGP
+ - TCP
+ - CBT
+ - EGP
+ - IGP
+ - BBN-RCC-MON
+ - NVP-II
+ - PUP
+ - EMCON
+ - XNET
+ - CHAOS
+ - UDP
+ - MUX
+ - DCN-MEAS
+ - HMP
+ - PRM
+ - XNS-IDP
+ - TRUNK-1
+ - TRUNK-2
+ - LEAF-1
+ - LEAF-2
+ - RDP
+ - IRTP
+ - ISO-TP4
+ - NETBLT
+ - MFE-NSP
+ - MERIT-INP
+ - DCCP
+ - 3PC
+ - IDPR
+ - XTP
+ - DDP
+ - IDPR-CMTP
+ - TP++
+ - IL
+ - SDRP
+ - IDRP
+ - RSVP
+ - GRE
+ - DSR
+ - BNA
+ - ESP
+ - AH
+ - I-NLSP
+ - NARP
+ - MOBILE
+ - TLSP
+ - SKIP
+ - CFTP
+ - SAT-EXPAK
+ - KRYPTOLAN
+ - RVD
+ - IPPC
+ - SAT-MON
+ - VISA
+ - IPCV
+ - CPNX
+ - CPHB
+ - WSN
+ - PVP
+ - BR-SAT-MON
+ - SUN-ND
+ - WB-MON
+ - WB-EXPAK
+ - ISO-IP
+ - VMTP
+ - SECURE-VMTP
+ - VINES
+ - TTP
+ - NSFNET-IGP
+ - DGP
+ - TCF
+ - EIGRP
+ - OSPFIGP
+ - Sprite-RPC
+ - LARP
+ - MTP
+ - AX.25
+ - IPIP
+ - SCC-SP
+ - ETHERIP
+ - ENCAP
+ - GMTP
+ - IFMP
+ - PNNI
+ - PIM
+ - ARIS
+ - SCPS
+ - QNX
+ - A/N
+ - IPComp
+ - SNP
+ - Compaq-Peer
+ - IPX-in-IP
+ - PGM
+ - L2TP
+ - DDX
+ - IATP
+ - STP
+ - SRP
+ - UTI
+ - SMP
+ - SM
+ - PTP
+ - FIRE
+ - CRTP
+ - CRUDP
+ - SSCOPMCE
+ - IPLT
+ - SPS
+ - PIPE
+ - SCTP
+ - FC
+ - RSVP-E2E-IGNORE
+ - UDPLite
+ - manet
+ - HIP
+ - WESP
+ - ROHC
+ - Ethernet
+ type: string
+ description: IANA IP Protocol (e.g. TCP UDP ICMP)
+ required:
+ - ip_protocol
+ - name
+ destination_service_groups:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ service_objects:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name of the service (e.g. HTTP)
+ maxLength: 100
+ port:
+ type: string
+ nullable: true
+ description: The port or port range to tie to a service (e.g.
+ HTTP would be port 80)
+ maxLength: 20
+ ip_protocol:
+ enum:
+ - ICMP
+ - IGMP
+ - GGP
+ - TCP
+ - CBT
+ - EGP
+ - IGP
+ - BBN-RCC-MON
+ - NVP-II
+ - PUP
+ - EMCON
+ - XNET
+ - CHAOS
+ - UDP
+ - MUX
+ - DCN-MEAS
+ - HMP
+ - PRM
+ - XNS-IDP
+ - TRUNK-1
+ - TRUNK-2
+ - LEAF-1
+ - LEAF-2
+ - RDP
+ - IRTP
+ - ISO-TP4
+ - NETBLT
+ - MFE-NSP
+ - MERIT-INP
+ - DCCP
+ - 3PC
+ - IDPR
+ - XTP
+ - DDP
+ - IDPR-CMTP
+ - TP++
+ - IL
+ - SDRP
+ - IDRP
+ - RSVP
+ - GRE
+ - DSR
+ - BNA
+ - ESP
+ - AH
+ - I-NLSP
+ - NARP
+ - MOBILE
+ - TLSP
+ - SKIP
+ - CFTP
+ - SAT-EXPAK
+ - KRYPTOLAN
+ - RVD
+ - IPPC
+ - SAT-MON
+ - VISA
+ - IPCV
+ - CPNX
+ - CPHB
+ - WSN
+ - PVP
+ - BR-SAT-MON
+ - SUN-ND
+ - WB-MON
+ - WB-EXPAK
+ - ISO-IP
+ - VMTP
+ - SECURE-VMTP
+ - VINES
+ - TTP
+ - NSFNET-IGP
+ - DGP
+ - TCF
+ - EIGRP
+ - OSPFIGP
+ - Sprite-RPC
+ - LARP
+ - MTP
+ - AX.25
+ - IPIP
+ - SCC-SP
+ - ETHERIP
+ - ENCAP
+ - GMTP
+ - IFMP
+ - PNNI
+ - PIM
+ - ARIS
+ - SCPS
+ - QNX
+ - A/N
+ - IPComp
+ - SNP
+ - Compaq-Peer
+ - IPX-in-IP
+ - PGM
+ - L2TP
+ - DDX
+ - IATP
+ - STP
+ - SRP
+ - UTI
+ - SMP
+ - SM
+ - PTP
+ - FIRE
+ - CRTP
+ - CRUDP
+ - SSCOPMCE
+ - IPLT
+ - SPS
+ - PIPE
+ - SCTP
+ - FC
+ - RSVP-E2E-IGNORE
+ - UDPLite
+ - manet
+ - HIP
+ - WESP
+ - ROHC
+ - Ethernet
+ type: string
+ description: IANA IP Protocol (e.g. TCP UDP ICMP)
+ required:
+ - ip_protocol
+ - name
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ required:
+ - name
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ action:
+ $ref: '#/components/schemas/ActionEnum'
+ log:
+ type: boolean
+ request_id:
+ type: string
+ nullable: true
+ maxLength: 100
+ description:
+ type: string
+ nullable: true
+ maxLength: 200
+ index:
+ type: integer
+ maximum: 32767
+ minimum: 0
+ nullable: true
+ required:
+ - action
+ - id
+ - name
+ BulkWritablePowerFeedRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ power_panel:
+ $ref: '#/components/schemas/NestedPowerPanelRequest'
+ rack:
+ allOf:
+ - $ref: '#/components/schemas/NestedRackRequest'
+ nullable: true
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ status:
+ $ref: '#/components/schemas/PowerFeedStatusChoices'
+ type:
+ allOf:
+ - $ref: '#/components/schemas/PowerFeedTypeChoices'
+ default:
+ value: primary
+ label: Primary
+ supply:
+ allOf:
+ - $ref: '#/components/schemas/SupplyEnum'
+ default:
+ value: ac
+ label: AC
+ phase:
+ allOf:
+ - $ref: '#/components/schemas/PhaseEnum'
+ 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
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ - name
+ - power_panel
+ - status
+ BulkWritablePowerOutletRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ device:
+ $ref: '#/components/schemas/NestedDeviceRequest'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ label:
+ type: string
+ description: Physical label
+ maxLength: 64
+ type:
+ $ref: '#/components/schemas/PowerOutletTypeChoices'
+ power_port:
+ $ref: '#/components/schemas/NestedPowerPortRequest'
+ feed_leg:
+ $ref: '#/components/schemas/FeedLegEnum'
+ description:
+ type: string
+ maxLength: 200
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - device
+ - id
+ - name
+ BulkWritablePowerOutletTemplateRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ device_type:
+ $ref: '#/components/schemas/NestedDeviceTypeRequest'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ label:
+ type: string
+ description: Physical label
+ maxLength: 64
+ type:
+ $ref: '#/components/schemas/PowerOutletTypeChoices'
+ power_port:
+ $ref: '#/components/schemas/NestedPowerPortTemplateRequest'
+ feed_leg:
+ $ref: '#/components/schemas/FeedLegEnum'
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - device_type
+ - id
+ - name
+ BulkWritablePowerPanelRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ site:
+ $ref: '#/components/schemas/NestedSiteRequest'
+ location:
+ allOf:
+ - $ref: '#/components/schemas/NestedLocationRequest'
+ nullable: true
+ rack_group:
+ allOf:
+ - $ref: '#/components/schemas/NestedRackGroupRequest'
+ nullable: true
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ - name
+ - site
+ BulkWritablePowerPortRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ device:
+ $ref: '#/components/schemas/NestedDeviceRequest'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ label:
+ type: string
+ description: Physical label
+ maxLength: 64
+ type:
+ $ref: '#/components/schemas/PowerPortTypeChoices'
+ 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
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - device
+ - id
+ - name
+ BulkWritablePowerPortTemplateRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ device_type:
+ $ref: '#/components/schemas/NestedDeviceTypeRequest'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ label:
+ type: string
+ description: Physical label
+ maxLength: 64
+ type:
+ $ref: '#/components/schemas/PowerPortTypeChoices'
+ 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: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - device_type
+ - id
+ - name
+ BulkWritablePrefixRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ prefix:
+ type: string
+ minLength: 1
+ site:
+ allOf:
+ - $ref: '#/components/schemas/NestedSiteRequest'
+ nullable: true
+ location:
+ allOf:
+ - $ref: '#/components/schemas/NestedLocationRequest'
+ nullable: true
+ vrf:
+ allOf:
+ - $ref: '#/components/schemas/NestedVRFRequest'
+ nullable: true
+ tenant:
+ allOf:
+ - $ref: '#/components/schemas/NestedTenantRequest'
+ nullable: true
+ vlan:
+ allOf:
+ - $ref: '#/components/schemas/NestedVLANRequest'
+ nullable: true
+ status:
+ $ref: '#/components/schemas/PrefixStatusChoices'
+ role:
+ allOf:
+ - $ref: '#/components/schemas/NestedRoleRequest'
+ 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/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ - prefix
+ - status
+ BulkWritableProviderLCMRequest:
+ type: object
+ description: API serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ 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/TagSerializerFieldRequest'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ - name
+ BulkWritableProviderNetworkRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ provider:
+ $ref: '#/components/schemas/NestedProviderRequest'
+ name:
+ type: string
+ minLength: 1
+ 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/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ - name
+ - provider
+ BulkWritableProviderRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ 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/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ - name
+ BulkWritableRIRRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ 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
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ - name
+ BulkWritableRackGroupRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ site:
+ $ref: '#/components/schemas/NestedSiteRequest'
+ location:
+ allOf:
+ - $ref: '#/components/schemas/NestedLocationRequest'
+ nullable: true
+ parent:
+ allOf:
+ - $ref: '#/components/schemas/NestedRackGroupRequest'
+ nullable: true
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ - name
+ - site
+ BulkWritableRackRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ facility_id:
+ type: string
+ nullable: true
+ description: Locally-assigned identifier
+ maxLength: 50
+ site:
+ $ref: '#/components/schemas/NestedSiteRequest'
+ location:
+ allOf:
+ - $ref: '#/components/schemas/NestedLocationRequest'
+ nullable: true
+ group:
+ allOf:
+ - $ref: '#/components/schemas/NestedRackGroupRequest'
+ nullable: true
+ tenant:
+ allOf:
+ - $ref: '#/components/schemas/NestedTenantRequest'
+ nullable: true
+ status:
+ $ref: '#/components/schemas/RackStatusChoices'
+ role:
+ allOf:
+ - $ref: '#/components/schemas/NestedRackRoleRequest'
+ 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:
+ $ref: '#/components/schemas/RackTypeChoices'
+ width:
+ $ref: '#/components/schemas/WidthEnum'
+ 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:
+ $ref: '#/components/schemas/OuterUnitEnum'
+ comments:
+ type: string
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ - name
+ - site
+ - status
+ BulkWritableRackReservationRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ rack:
+ $ref: '#/components/schemas/NestedRackRequest'
+ units:
+ type: object
+ additionalProperties: {}
+ user:
+ $ref: '#/components/schemas/NestedUserRequest'
+ tenant:
+ allOf:
+ - $ref: '#/components/schemas/NestedTenantRequest'
+ nullable: true
+ description:
+ type: string
+ minLength: 1
+ maxLength: 200
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - description
+ - id
+ - rack
+ - units
+ - user
+ BulkWritableRackRoleRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ color:
+ type: string
+ minLength: 1
+ pattern: ^[0-9a-f]{6}$
+ maxLength: 6
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ - name
+ BulkWritableRearPortRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ device:
+ $ref: '#/components/schemas/NestedDeviceRequest'
+ name:
+ type: string
+ minLength: 1
+ 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
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - device
+ - id
+ - name
+ - type
+ BulkWritableRearPortTemplateRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ device_type:
+ $ref: '#/components/schemas/NestedDeviceTypeRequest'
+ name:
+ type: string
+ minLength: 1
+ 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: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - device_type
+ - id
+ - name
+ - type
+ BulkWritableRegionRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ parent:
+ allOf:
+ - $ref: '#/components/schemas/NestedRegionRequest'
+ nullable: true
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ - name
+ BulkWritableRegularExpressionValidationRuleRequest:
+ type: object
+ description: Serializer for `RegularExpressionValidationRule` objects.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ minLength: 1
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ content_type:
+ type: string
+ field:
+ type: string
+ minLength: 1
+ maxLength: 50
+ regular_expression:
+ type: string
+ minLength: 1
+ enabled:
+ type: boolean
+ error_message:
+ type: string
+ nullable: true
+ description: Optional error message to display when validation fails.
+ maxLength: 255
+ required:
+ - content_type
+ - field
+ - id
+ - name
+ - regular_expression
+ - slug
+ BulkWritableRelationshipAssociationRequest:
+ 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
+ relationship:
+ $ref: '#/components/schemas/NestedRelationshipRequest'
+ 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
+ BulkWritableRelationshipRequest:
+ 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
+ name:
+ type: string
+ minLength: 1
+ description: Name of the relationship as displayed to users
+ maxLength: 100
+ slug:
+ type: string
+ description: Internal relationship name. Please use underscores rather than
+ dashes in this slug.
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ description:
+ type: string
+ maxLength: 200
+ type:
+ allOf:
+ - $ref: '#/components/schemas/RelationshipTypeChoices'
+ description: Cardinality of this relationship
+ required_on:
+ description: Objects on the specified side MUST implement this relationship.
+ Not permitted for symmetric relationships.
+ oneOf:
+ - $ref: '#/components/schemas/RequiredOnEnum'
+ - $ref: '#/components/schemas/BlankEnum'
+ 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: Filterset 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: Filterset filter matching the applicable destination objects
+ of the selected type
+ required:
+ - destination_type
+ - id
+ - name
+ - source_type
+ BulkWritableRoleRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ weight:
+ type: integer
+ maximum: 32767
+ minimum: 0
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ - name
+ BulkWritableRouteTargetRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ description: Route target value (formatted in accordance with RFC 4360)
+ maxLength: 21
+ tenant:
+ allOf:
+ - $ref: '#/components/schemas/NestedTenantRequest'
+ nullable: true
+ description:
+ type: string
+ maxLength: 200
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ - name
+ BulkWritableSecretRequest:
+ type: object
+ description: Serializer for `Secret` objects.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ description:
+ type: string
+ maxLength: 200
+ provider:
+ type: string
+ minLength: 1
+ maxLength: 100
+ parameters:
+ type: object
+ additionalProperties: {}
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ - name
+ - provider
+ BulkWritableSecretsGroupAssociationRequest:
+ type: object
+ description: Serializer for `SecretsGroupAssociation` objects.
+ properties:
+ id:
+ type: string
+ format: uuid
+ group:
+ $ref: '#/components/schemas/NestedSecretsGroupRequest'
+ access_type:
+ $ref: '#/components/schemas/AccessTypeEnum'
+ secret_type:
+ $ref: '#/components/schemas/SecretTypeEnum'
+ secret:
+ $ref: '#/components/schemas/NestedSecretRequest'
+ required:
+ - access_type
+ - group
+ - id
+ - secret
+ - secret_type
+ BulkWritableSecretsGroupRequest:
+ type: object
+ description: Serializer for `SecretsGroup` objects.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ - name
+ BulkWritableServiceObjectGroupRequest:
+ type: object
+ description: ServiceObjectGroup Serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ service_objects:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name of the service (e.g. HTTP)
+ maxLength: 100
+ port:
+ type: string
+ nullable: true
+ description: The port or port range to tie to a service (e.g. HTTP
+ would be port 80)
+ maxLength: 20
+ ip_protocol:
+ enum:
+ - ICMP
+ - IGMP
+ - GGP
+ - TCP
+ - CBT
+ - EGP
+ - IGP
+ - BBN-RCC-MON
+ - NVP-II
+ - PUP
+ - EMCON
+ - XNET
+ - CHAOS
+ - UDP
+ - MUX
+ - DCN-MEAS
+ - HMP
+ - PRM
+ - XNS-IDP
+ - TRUNK-1
+ - TRUNK-2
+ - LEAF-1
+ - LEAF-2
+ - RDP
+ - IRTP
+ - ISO-TP4
+ - NETBLT
+ - MFE-NSP
+ - MERIT-INP
+ - DCCP
+ - 3PC
+ - IDPR
+ - XTP
+ - DDP
+ - IDPR-CMTP
+ - TP++
+ - IL
+ - SDRP
+ - IDRP
+ - RSVP
+ - GRE
+ - DSR
+ - BNA
+ - ESP
+ - AH
+ - I-NLSP
+ - NARP
+ - MOBILE
+ - TLSP
+ - SKIP
+ - CFTP
+ - SAT-EXPAK
+ - KRYPTOLAN
+ - RVD
+ - IPPC
+ - SAT-MON
+ - VISA
+ - IPCV
+ - CPNX
+ - CPHB
+ - WSN
+ - PVP
+ - BR-SAT-MON
+ - SUN-ND
+ - WB-MON
+ - WB-EXPAK
+ - ISO-IP
+ - VMTP
+ - SECURE-VMTP
+ - VINES
+ - TTP
+ - NSFNET-IGP
+ - DGP
+ - TCF
+ - EIGRP
+ - OSPFIGP
+ - Sprite-RPC
+ - LARP
+ - MTP
+ - AX.25
+ - IPIP
+ - SCC-SP
+ - ETHERIP
+ - ENCAP
+ - GMTP
+ - IFMP
+ - PNNI
+ - PIM
+ - ARIS
+ - SCPS
+ - QNX
+ - A/N
+ - IPComp
+ - SNP
+ - Compaq-Peer
+ - IPX-in-IP
+ - PGM
+ - L2TP
+ - DDX
+ - IATP
+ - STP
+ - SRP
+ - UTI
+ - SMP
+ - SM
+ - PTP
+ - FIRE
+ - CRTP
+ - CRUDP
+ - SSCOPMCE
+ - IPLT
+ - SPS
+ - PIPE
+ - SCTP
+ - FC
+ - RSVP-E2E-IGNORE
+ - UDPLite
+ - manet
+ - HIP
+ - WESP
+ - ROHC
+ - Ethernet
+ type: string
+ description: IANA IP Protocol (e.g. TCP UDP ICMP)
+ required:
+ - ip_protocol
+ - name
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ required:
+ - id
+ - name
+ BulkWritableServiceObjectRequest:
+ type: object
+ description: ServiceObject Serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name of the service (e.g. HTTP)
+ maxLength: 100
+ port:
+ type: string
+ nullable: true
+ description: The port or port range to tie to a service (e.g. HTTP would
+ be port 80)
+ maxLength: 20
+ ip_protocol:
+ allOf:
+ - $ref: '#/components/schemas/IpProtocolEnum'
+ description: IANA IP Protocol (e.g. TCP UDP ICMP)
+ required:
+ - id
+ - ip_protocol
+ - name
+ BulkWritableServiceRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ device:
+ allOf:
+ - $ref: '#/components/schemas/NestedDeviceRequest'
+ nullable: true
+ virtual_machine:
+ allOf:
+ - $ref: '#/components/schemas/NestedVirtualMachineRequest'
+ nullable: true
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ ports:
+ type: array
+ items:
+ type: integer
+ maximum: 65535
+ minimum: 1
+ protocol:
+ $ref: '#/components/schemas/ProtocolEnum'
+ ipaddresses:
+ type: array
+ items:
+ type: object
+ properties:
+ address:
+ type: string
+ minLength: 1
+ required:
+ - address
+ description:
+ type: string
+ maxLength: 200
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ - name
+ - ports
+ BulkWritableSiteRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ status:
+ $ref: '#/components/schemas/LocationStatusChoices'
+ region:
+ allOf:
+ - $ref: '#/components/schemas/NestedRegionRequest'
+ nullable: true
+ tenant:
+ allOf:
+ - $ref: '#/components/schemas/NestedTenantRequest'
+ 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/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ - name
+ - status
+ BulkWritableSoftwareImageLCMRequest:
+ type: object
+ description: REST API serializer for SoftwareImageLCM records.
+ properties:
+ id:
+ type: string
+ format: uuid
+ image_file_name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ software:
+ $ref: '#/components/schemas/NestedSoftwareLCMRequest'
+ 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/TagSerializerFieldRequest'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ - image_file_name
+ - software
+ BulkWritableSoftwareLCMRequest:
+ type: object
+ description: REST API serializer for SoftwareLCM records.
+ properties:
+ id:
+ type: string
+ format: uuid
+ device_platform:
+ $ref: '#/components/schemas/NestedPlatformRequest'
+ version:
+ type: string
+ minLength: 1
+ 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:
+ image_file_name:
+ type: string
+ minLength: 1
+ 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
+ required:
+ - image_file_name
+ long_term_support:
+ type: boolean
+ pre_release:
+ type: boolean
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - device_platform
+ - id
+ - version
+ BulkWritableStatusRequest:
+ type: object
+ description: Serializer for `Status` objects.
+ properties:
+ id:
+ type: string
+ format: uuid
+ content_types:
+ type: array
+ items:
+ type: string
+ name:
+ type: string
+ minLength: 1
+ maxLength: 50
+ slug:
+ type: string
+ maxLength: 50
+ pattern: ^[-a-zA-Z0-9_]+$
+ color:
+ type: string
+ minLength: 1
+ pattern: ^[0-9a-f]{6}$
+ maxLength: 6
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - content_types
+ - id
+ - name
+ BulkWritableTagSerializerVersion13Request:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ minLength: 1
+ pattern: ^[-\w]+$
+ maxLength: 100
+ color:
+ type: string
+ minLength: 1
+ pattern: ^[0-9a-f]{6}$
+ maxLength: 6
+ description:
+ type: string
+ maxLength: 200
+ content_types:
+ type: array
+ items:
+ type: string
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - content_types
+ - id
+ - name
+ - slug
+ BulkWritableTenantGroupRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ parent:
+ allOf:
+ - $ref: '#/components/schemas/NestedTenantGroupRequest'
+ nullable: true
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ - name
+ BulkWritableTenantRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ group:
+ $ref: '#/components/schemas/NestedTenantGroupRequest'
+ description:
+ type: string
+ maxLength: 200
+ comments:
+ type: string
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ - name
+ BulkWritableTokenRequest:
+ 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
+ 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:
+ - id
+ BulkWritableUserObjectGroupRequest:
+ type: object
+ description: UserObjectGroup Serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ user_objects:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ username:
+ type: string
+ minLength: 1
+ description: Signifies the username in identify provider (e.g. john.smith)
+ maxLength: 100
+ name:
+ type: string
+ description: Signifies the name of the user, commonly first & last
+ name (e.g. John Smith)
+ maxLength: 100
+ required:
+ - username
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ required:
+ - id
+ - name
+ BulkWritableUserObjectRequest:
+ type: object
+ description: UserObject Serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ username:
+ type: string
+ minLength: 1
+ description: Signifies the username in identify provider (e.g. john.smith)
+ maxLength: 100
+ name:
+ type: string
+ description: Signifies the name of the user, commonly first & last name
+ (e.g. John Smith)
+ maxLength: 100
+ required:
+ - id
+ - username
+ BulkWritableUserRequest:
+ 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
+ username:
+ type: string
+ minLength: 1
+ description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_
+ only.
+ pattern: ^[\w.@+-]+$
+ maxLength: 150
+ password:
+ type: string
+ writeOnly: true
+ minLength: 1
+ 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:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 150
+ required:
+ - name
+ required:
+ - id
+ - password
+ - username
+ BulkWritableVLANGroupRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ site:
+ allOf:
+ - $ref: '#/components/schemas/NestedSiteRequest'
+ nullable: true
+ location:
+ allOf:
+ - $ref: '#/components/schemas/NestedLocationRequest'
+ nullable: true
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ - name
+ BulkWritableVLANRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ site:
+ allOf:
+ - $ref: '#/components/schemas/NestedSiteRequest'
+ nullable: true
+ location:
+ allOf:
+ - $ref: '#/components/schemas/NestedLocationRequest'
+ nullable: true
+ group:
+ allOf:
+ - $ref: '#/components/schemas/NestedVLANGroupRequest'
+ nullable: true
+ vid:
+ type: integer
+ maximum: 4094
+ minimum: 1
+ title: ID
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ tenant:
+ allOf:
+ - $ref: '#/components/schemas/NestedTenantRequest'
+ nullable: true
+ status:
+ $ref: '#/components/schemas/VLANStatusChoices'
+ role:
+ allOf:
+ - $ref: '#/components/schemas/NestedRoleRequest'
+ nullable: true
+ description:
+ type: string
+ maxLength: 200
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ - name
+ - status
+ - vid
+ BulkWritableVMInterfaceRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ virtual_machine:
+ $ref: '#/components/schemas/NestedVirtualMachineRequest'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ enabled:
+ type: boolean
+ status:
+ $ref: '#/components/schemas/InterfaceStatusChoices'
+ parent_interface:
+ allOf:
+ - $ref: '#/components/schemas/NestedVMInterfaceRequest'
+ nullable: true
+ bridge:
+ allOf:
+ - $ref: '#/components/schemas/NestedVMInterfaceRequest'
+ nullable: true
+ mtu:
+ type: integer
+ maximum: 65536
+ minimum: 1
+ nullable: true
+ mac_address:
+ type: string
+ nullable: true
+ maxLength: 18
+ description:
+ type: string
+ maxLength: 200
+ mode:
+ $ref: '#/components/schemas/ModeEnum'
+ untagged_vlan:
+ allOf:
+ - $ref: '#/components/schemas/NestedVLANRequest'
+ nullable: true
+ tagged_vlans:
+ type: array
+ items:
+ type: object
+ properties:
+ vid:
+ type: integer
+ maximum: 4094
+ minimum: 1
+ title: ID
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ required:
+ - name
+ - vid
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ - name
+ - status
+ - virtual_machine
+ BulkWritableVRFRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ 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/NestedTenantRequest'
+ 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:
+ name:
+ type: string
+ minLength: 1
+ description: Route target value (formatted in accordance with RFC
+ 4360)
+ maxLength: 21
+ required:
+ - name
+ export_targets:
+ type: array
+ items:
+ type: object
+ properties:
+ name:
+ type: string
+ minLength: 1
+ description: Route target value (formatted in accordance with RFC
+ 4360)
+ maxLength: 21
+ required:
+ - name
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ - name
+ BulkWritableValidatedSoftwareLCMRequest:
+ type: object
+ description: REST API serializer for ValidatedSoftwareLCM records.
+ properties:
+ id:
+ type: string
+ format: uuid
+ software:
+ $ref: '#/components/schemas/NestedSoftwareLCMRequest'
+ 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
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ - software
+ - start
+ BulkWritableVirtualChassisRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ domain:
+ type: string
+ maxLength: 30
+ master:
+ allOf:
+ - $ref: '#/components/schemas/NestedDeviceRequest'
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ - name
+ BulkWritableVirtualMachineWithConfigContextRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ status:
+ $ref: '#/components/schemas/VirtualMachineStatusChoices'
+ cluster:
+ $ref: '#/components/schemas/NestedClusterRequest'
+ role:
+ allOf:
+ - $ref: '#/components/schemas/NestedDeviceRoleRequest'
+ nullable: true
+ tenant:
+ allOf:
+ - $ref: '#/components/schemas/NestedTenantRequest'
+ nullable: true
+ platform:
+ allOf:
+ - $ref: '#/components/schemas/NestedPlatformRequest'
+ nullable: true
+ primary_ip4:
+ allOf:
+ - $ref: '#/components/schemas/NestedIPAddressRequest'
+ nullable: true
+ primary_ip6:
+ allOf:
+ - $ref: '#/components/schemas/NestedIPAddressRequest'
+ 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/NestedConfigContextSchemaRequest'
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - cluster
+ - id
+ - name
+ - status
+ BulkWritableVulnerabilityLCMRequest:
+ type: object
+ description: REST API serializer for VulnerabilityLCM records.
+ properties:
+ id:
+ type: string
+ format: uuid
+ status:
+ $ref: '#/components/schemas/Status4f5Enum'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ - status
+ BulkWritableWebhookRequest:
+ 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
+ content_types:
+ type: array
+ items:
+ type: string
+ name:
+ type: string
+ minLength: 1
+ 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
+ minLength: 1
+ 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
+ minLength: 1
+ description: The complete list of official content types is available here.
+ 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
+ Name: Value. 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: event, model, timestamp,
+ username, request_id, and data.'
+ 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
+ required:
+ - content_types
+ - id
+ - name
+ - payload_url
+ BulkWritableZoneRequest:
+ type: object
+ description: Zone Serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ interfaces:
+ type: array
+ items:
+ $ref: '#/components/schemas/NestedInterfaceRequest'
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name of the zone (e.g. trust)
+ maxLength: 100
+ required:
+ - id
+ - name
+ ButtonClassEnum:
+ enum:
+ - default
+ - primary
+ - success
+ - info
+ - warning
+ - danger
+ - link
+ type: string
+ CVELCM:
+ type: object
+ description: REST API serializer for CVELCM records.
+ properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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: object
+ properties:
+ value:
+ type: string
+ enum:
+ - Critical
+ - High
+ - Medium
+ - Low
+ - None
+ label:
+ type: string
+ enum:
+ - Critical
+ - High
+ - Medium
+ - Low
+ - None
+ 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'
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - link
+ - name
+ - published_date
+ - url
+ Cable:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ 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
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - notes_url
+ - status
+ - termination_a
+ - termination_a_id
+ - termination_a_type
+ - termination_b
+ - termination_b_id
+ - termination_b_type
+ - url
+ CableStatusChoices:
+ type: string
+ enum:
+ - connected
+ - decommissioning
+ - planned
+ 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
+ CapircaPolicy:
+ type: object
+ description: CapircaPolicy Serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ pol:
+ type: string
+ nullable: true
+ net:
+ type: string
+ nullable: true
+ svc:
+ type: string
+ nullable: true
+ cfg:
+ type: string
+ nullable: true
+ device:
+ type: string
+ format: uuid
+ nullable: true
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - url
+ CapircaPolicyRequest:
+ type: object
+ description: CapircaPolicy Serializer.
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ pol:
+ type: string
+ nullable: true
+ net:
+ type: string
+ nullable: true
+ svc:
+ type: string
+ nullable: true
+ cfg:
+ type: string
+ nullable: true
+ device:
+ type: string
+ format: uuid
+ nullable: true
+ Circuit:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ 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
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - cid
+ - created
+ - display
+ - id
+ - last_updated
+ - notes_url
+ - 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ site:
+ $ref: '#/components/schemas/NestedSite'
+ location:
+ allOf:
+ - $ref: '#/components/schemas/NestedLocation'
+ nullable: true
+ 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
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ required:
+ - connected_endpoint
+ - created
+ - display
+ - id
+ - last_updated
+ - notes_url
+ - provider_network
+ - site
+ - url
+ CircuitCircuitTerminationRequest:
+ 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:
+ site:
+ $ref: '#/components/schemas/NestedSiteRequest'
+ location:
+ allOf:
+ - $ref: '#/components/schemas/NestedLocationRequest'
+ nullable: true
+ provider_network:
+ $ref: '#/components/schemas/NestedProviderNetworkRequest'
+ connected_endpoint:
+ $ref: '#/components/schemas/NestedInterfaceRequest'
+ 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
+ required:
+ - id
+ 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/StatusD95Enum'
+ - $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
+ CircuitMaintenanceCircuitImpactRequest:
+ type: object
+ description: Serializer for API.
+ properties:
+ 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
+ - maintenance
+ CircuitMaintenanceRequest:
+ type: object
+ description: Serializer for API.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ 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/StatusD95Enum'
+ - $ref: '#/components/schemas/BlankEnum'
+ - $ref: '#/components/schemas/NullEnum'
+ ack:
+ type: boolean
+ nullable: true
+ required:
+ - end_time
+ - start_time
+ CircuitStatusChoices:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - deprovisioning
+ - offline
+ - planned
+ - provisioning
+ CircuitTermination:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ circuit:
+ $ref: '#/components/schemas/NestedCircuit'
+ term_side:
+ allOf:
+ - $ref: '#/components/schemas/TermSideEnum'
+ title: Termination
+ site:
+ allOf:
+ - $ref: '#/components/schemas/NestedSite'
+ nullable: true
+ location:
+ allOf:
+ - $ref: '#/components/schemas/NestedLocation'
+ 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
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - cable
+ - cable_peer
+ - cable_peer_type
+ - circuit
+ - connected_endpoint
+ - connected_endpoint_reachable
+ - connected_endpoint_type
+ - created
+ - display
+ - id
+ - last_updated
+ - notes_url
+ - term_side
+ - url
+ CircuitType:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ 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
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - circuit_count
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - url
+ CircuitTypeRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - name
+ Cluster:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ 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
+ location:
+ allOf:
+ - $ref: '#/components/schemas/NestedLocation'
+ nullable: true
+ comments:
+ type: string
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ device_count:
+ type: integer
+ readOnly: true
+ virtualmachine_count:
+ type: integer
+ readOnly: true
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - created
+ - device_count
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - type
+ - url
+ - virtualmachine_count
+ ClusterGroup:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ 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
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - cluster_count
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - url
+ ClusterGroupRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - name
+ ClusterType:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ 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
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - cluster_count
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - url
+ ClusterTypeRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - name
+ CommandToken:
+ type: object
+ description: API serializer for interacting with CommandToken objects.
+ properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - platform
+ - token
+ - url
+ CommandTokenRequest:
+ type: object
+ description: API serializer for interacting with CommandToken objects.
+ properties:
+ comment:
+ type: string
+ description: 'Optional: Enter description of token'
+ maxLength: 255
+ platform:
+ $ref: '#/components/schemas/PlatformEnum'
+ token:
+ type: string
+ minLength: 1
+ description: Token given by chat platform for signing or command validation
+ maxLength: 255
+ required:
+ - platform
+ - token
+ ComplianceFeature:
+ type: object
+ description: Serializer for ComplianceFeature object.
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: 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:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - slug
+ - url
+ ComplianceFeatureRequest:
+ type: object
+ description: Serializer for ComplianceFeature object.
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ minLength: 1
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ description:
+ type: string
+ maxLength: 200
+ required:
+ - name
+ - slug
+ ComplianceRule:
+ type: object
+ description: Serializer for ComplianceRule object.
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: 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:
+ - config_ordered
+ - created
+ - display
+ - feature
+ - id
+ - last_updated
+ - platform
+ - url
+ ComplianceRuleRequest:
+ type: object
+ description: Serializer for ComplianceRule object.
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _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:
+ - config_ordered
+ - feature
+ - platform
+ 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
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ slug:
+ type: string
+ description: Internal field name. Please use underscores rather than dashes
+ in this slug.
+ 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
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ required:
+ - content_type
+ - created
+ - display
+ - id
+ - label
+ - last_updated
+ - notes_url
+ - template
+ - url
+ ComputedFieldRequest:
+ 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:
+ slug:
+ type: string
+ description: Internal field name. Please use underscores rather than dashes
+ in this slug.
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ label:
+ type: string
+ minLength: 1
+ description: Name of the field as displayed to users
+ maxLength: 100
+ description:
+ type: string
+ maxLength: 200
+ content_type:
+ type: string
+ template:
+ type: string
+ minLength: 1
+ 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
+ required:
+ - content_type
+ - label
+ - template
+ ConfigCompliance:
+ type: object
+ description: Serializer for ConfigCompliance object.
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: 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:
+ - created
+ - device
+ - display
+ - id
+ - last_updated
+ - rule
+ ConfigComplianceRequest:
+ type: object
+ description: Serializer for ConfigCompliance object.
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _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:
+ - device
+ - 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
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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'
+ required:
+ - _depth
+ - display
+ - id
+ - name
+ - site_count
+ - url
+ sites:
+ type: array
+ items:
+ type: object
+ properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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_]+$
+ required:
+ - display
+ - id
+ - name
+ - url
+ locations:
+ type: array
+ items:
+ type: object
+ properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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_]+$
+ tree_depth:
+ type: integer
+ nullable: true
+ readOnly: true
+ required:
+ - display
+ - id
+ - name
+ - tree_depth
+ - url
+ roles:
+ type: array
+ items:
+ type: object
+ properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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
+ required:
+ - device_count
+ - display
+ - id
+ - name
+ - url
+ - virtualmachine_count
+ device_types:
+ type: array
+ items:
+ type: object
+ properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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
+ required:
+ - device_count
+ - display
+ - id
+ - manufacturer
+ - model
+ - slug
+ - url
+ platforms:
+ type: array
+ items:
+ type: object
+ properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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
+ required:
+ - device_count
+ - display
+ - id
+ - name
+ - url
+ - virtualmachine_count
+ cluster_groups:
+ type: array
+ items:
+ type: object
+ properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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
+ required:
+ - cluster_count
+ - display
+ - id
+ - name
+ - url
+ clusters:
+ type: array
+ items:
+ type: object
+ properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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
+ required:
+ - display
+ - id
+ - name
+ - url
+ - virtualmachine_count
+ tenant_groups:
+ type: array
+ items:
+ type: object
+ properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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'
+ required:
+ - _depth
+ - display
+ - id
+ - name
+ - tenant_count
+ - url
+ tenants:
+ type: array
+ items:
+ type: object
+ properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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_]+$
+ required:
+ - display
+ - id
+ - name
+ - url
+ tags:
+ type: array
+ items:
+ type: string
+ data:
+ type: object
+ additionalProperties: {}
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ required:
+ - created
+ - data
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - owner
+ - url
+ ConfigContextSchema:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ 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
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - created
+ - data_schema
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - owner
+ - url
+ ConfigContextSchemaRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ 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
+ description:
+ type: string
+ maxLength: 200
+ data_schema:
+ type: object
+ additionalProperties: {}
+ description: A JSON Schema document which is used to validate a config context
+ object.
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - data_schema
+ - name
+ ConfigRemove:
+ type: object
+ description: Serializer for ConfigRemove object.
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: 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:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - platform
+ - regex
+ - url
+ ConfigRemoveRequest:
+ type: object
+ description: Serializer for ConfigRemove object.
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 255
+ description:
+ type: string
+ maxLength: 200
+ regex:
+ type: string
+ minLength: 1
+ title: Regex Pattern
+ description: Regex pattern used to remove a line from the backup configuration.
+ maxLength: 200
+ platform:
+ type: string
+ format: uuid
+ required:
+ - name
+ - platform
+ - regex
+ ConfigReplace:
+ type: object
+ description: Serializer for ConfigReplace object.
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: 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:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - platform
+ - regex
+ - replace
+ - url
+ ConfigReplaceRequest:
+ type: object
+ description: Serializer for ConfigReplace object.
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 255
+ description:
+ type: string
+ maxLength: 200
+ regex:
+ type: string
+ minLength: 1
+ title: Regex Pattern to Substitute
+ description: Regex pattern that will be found and replaced with 'replaced
+ text'.
+ maxLength: 200
+ replace:
+ type: string
+ minLength: 1
+ title: Replaced Text
+ description: Text that will be inserted in place of Regex pattern match.
+ maxLength: 200
+ platform:
+ type: string
+ format: uuid
+ required:
+ - name
+ - platform
+ - regex
+ - replace
+ ConfigToPush:
+ type: object
+ description: Serializer for ConfigToPush view.
+ 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
+ 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'
+ location:
+ allOf:
+ - $ref: '#/components/schemas/NestedLocation'
+ nullable: true
+ 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
+ device_redundancy_group:
+ allOf:
+ - $ref: '#/components/schemas/NestedDeviceRedundancyGroup'
+ nullable: true
+ device_redundancy_group_priority:
+ type: integer
+ maximum: 32767
+ minimum: 1
+ nullable: true
+ description: The priority the device has in the device redundancy group.
+ comments:
+ type: string
+ local_context_schema:
+ allOf:
+ - $ref: '#/components/schemas/NestedConfigContextSchema'
+ nullable: true
+ local_context_data:
+ type: object
+ additionalProperties: {}
+ nullable: true
+ config:
+ type: string
+ readOnly: true
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - config
+ - created
+ - device_role
+ - device_type
+ - display
+ - id
+ - last_updated
+ - notes_url
+ - parent_device
+ - primary_ip
+ - site
+ - status
+ - url
+ ConfigTypeEnum:
+ enum:
+ - cli
+ - json
+ - custom
+ type: string
+ ConsolePort:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ 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
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - cable
+ - cable_peer
+ - cable_peer_type
+ - connected_endpoint
+ - connected_endpoint_reachable
+ - connected_endpoint_type
+ - created
+ - device
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - url
+ ConsolePortTemplate:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ 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
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - created
+ - device_type
+ - display
+ - id
+ - last_updated
+ - name
+ - url
+ ConsolePortTypeChoices:
+ 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
+ ConsoleServerPort:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ 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
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - cable
+ - cable_peer
+ - cable_peer_type
+ - connected_endpoint
+ - connected_endpoint_reachable
+ - connected_endpoint_type
+ - created
+ - device
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - url
+ ConsoleServerPortTemplate:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ 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
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - created
+ - device_type
+ - display
+ - id
+ - last_updated
+ - name
+ - url
+ ContactLCM:
+ type: object
+ description: API serializer.
+ 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
+ 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'
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ required:
+ - contract
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - url
+ ContentType:
+ 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.
+ - ensures that `id` field is always present on the serializer as well
+ - ensures that `created` and `last_updated` fields are always present if applicable to this model and serializer.
+ properties:
+ id:
+ type: integer
+ readOnly: true
+ display:
+ type: string
+ 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
+ required:
+ - app_label
+ - display
+ - id
+ - model
+ - url
+ ContractLCM:
+ type: object
+ description: API serializer.
+ properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ 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'
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ required:
+ - created
+ - display
+ - expired
+ - id
+ - last_updated
+ - name
+ - provider
+ - 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
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ required:
+ - created
+ - display
+ - field
+ - id
+ - last_updated
+ - url
+ - value
+ CustomFieldSerializerVersion12:
+ 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
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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
+ label:
+ type: string
+ maxLength: 50
+ name:
+ type: string
+ description: Human-readable unique name of this field.
+ maxLength: 50
+ slug:
+ type: string
+ 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, ^[A-Z]{3}$
+ will limit values to exactly three uppercase letters. Regular expression
+ on select and multi-select will be applied at Custom Field Choices
+ definition.
+ maxLength: 500
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ required:
+ - content_types
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - type
+ - url
+ CustomFieldSerializerVersion12Request:
+ 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:
+ content_types:
+ type: array
+ items:
+ type: string
+ type:
+ $ref: '#/components/schemas/CustomFieldTypeChoices'
+ label:
+ type: string
+ minLength: 1
+ maxLength: 50
+ name:
+ type: string
+ minLength: 1
+ description: Human-readable unique name of this field.
+ maxLength: 50
+ slug:
+ type: string
+ minLength: 1
+ 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:
+ $ref: '#/components/schemas/FilterLogicEnum'
+ 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, ^[A-Z]{3}$
+ will limit values to exactly three uppercase letters. Regular expression
+ on select and multi-select will be applied at Custom Field Choices
+ definition.
+ maxLength: 500
+ required:
+ - id
+ CustomFieldTypeChoices:
+ type: string
+ enum:
+ - text
+ - integer
+ - boolean
+ - date
+ - url
+ - select
+ - multi-select
+ - json
+ 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
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ target_url:
+ type: string
+ title: URL
+ description: Jinja2 template code for link URL. Reference the object as
+ {{ obj }} such as {{ obj.platform.slug }}.
+ 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
+ {{ obj }} such as {{ obj.platform.slug }}. 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
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ required:
+ - content_type
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - new_window
+ - notes_url
+ - target_url
+ - text
+ - url
+ CustomLinkRequest:
+ 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:
+ target_url:
+ type: string
+ minLength: 1
+ title: URL
+ description: Jinja2 template code for link URL. Reference the object as
+ {{ obj }} such as {{ obj.platform.slug }}.
+ maxLength: 500
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ content_type:
+ type: string
+ text:
+ type: string
+ minLength: 1
+ description: Jinja2 template code for link text. Reference the object as
+ {{ obj }} such as {{ obj.platform.slug }}. 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
+ required:
+ - content_type
+ - name
+ - new_window
+ - target_url
+ - text
+ Device:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ 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'
+ location:
+ allOf:
+ - $ref: '#/components/schemas/NestedLocation'
+ nullable: true
+ 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
+ device_redundancy_group:
+ allOf:
+ - $ref: '#/components/schemas/NestedDeviceRedundancyGroup'
+ nullable: true
+ device_redundancy_group_priority:
+ type: integer
+ maximum: 32767
+ minimum: 1
+ nullable: true
+ description: The priority the device has in the device redundancy group.
+ comments:
+ type: string
+ local_context_schema:
+ allOf:
+ - $ref: '#/components/schemas/NestedConfigContextSchema'
+ nullable: true
+ local_context_data:
+ type: object
+ additionalProperties: {}
+ nullable: true
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - created
+ - device_role
+ - device_type
+ - display
+ - id
+ - last_updated
+ - notes_url
+ - parent_device
+ - primary_ip
+ - site
+ - status
+ - url
+ DeviceBay:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ 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
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - created
+ - device
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - url
+ DeviceBayTemplate:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ device_type:
+ $ref: '#/components/schemas/NestedDeviceType'
+ name:
+ type: string
+ maxLength: 64
+ label:
+ type: string
+ description: Physical label
+ maxLength: 64
+ description:
+ type: string
+ maxLength: 200
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - created
+ - device_type
+ - display
+ - id
+ - last_updated
+ - name
+ - url
+ DeviceNAPALM:
+ type: object
+ properties:
+ method:
+ type: object
+ additionalProperties: {}
+ required:
+ - method
+ DeviceRedundancyGroup:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ name:
+ type: string
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ description:
+ type: string
+ maxLength: 200
+ failover_strategy:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active-active
+ - active-passive
+ label:
+ type: string
+ enum:
+ - Active/Active
+ - Active/Passive
+ secrets_group:
+ type: string
+ format: uuid
+ nullable: true
+ comments:
+ type: string
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioning
+ - planned
+ - retired
+ - staging
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioning
+ - Planned
+ - Retired
+ - Staging
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - created
+ - display
+ - failover_strategy
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - status
+ - url
+ DeviceRole:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ 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
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - created
+ - device_count
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - url
+ - virtualmachine_count
+ DeviceRoleRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ color:
+ type: string
+ minLength: 1
+ 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
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - name
+ DeviceStatusChoices:
+ type: string
+ enum:
+ - active
+ - decommissioning
+ - failed
+ - inventory
+ - offline
+ - planned
+ - staged
+ DeviceType:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ 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
+ device_count:
+ type: integer
+ readOnly: true
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - created
+ - device_count
+ - display
+ - id
+ - last_updated
+ - manufacturer
+ - model
+ - notes_url
+ - url
+ DeviceWithConfigContext:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ 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'
+ location:
+ allOf:
+ - $ref: '#/components/schemas/NestedLocation'
+ nullable: true
+ 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
+ device_redundancy_group:
+ allOf:
+ - $ref: '#/components/schemas/NestedDeviceRedundancyGroup'
+ nullable: true
+ device_redundancy_group_priority:
+ type: integer
+ maximum: 32767
+ minimum: 1
+ nullable: true
+ description: The priority the device has in the device redundancy group.
+ comments:
+ type: string
+ local_context_schema:
+ allOf:
+ - $ref: '#/components/schemas/NestedConfigContextSchema'
+ nullable: true
+ local_context_data:
+ type: object
+ additionalProperties: {}
+ nullable: true
+ config_context:
+ type: object
+ additionalProperties: {}
+ readOnly: true
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - config_context
+ - created
+ - device_role
+ - device_type
+ - display
+ - id
+ - last_updated
+ - notes_url
+ - parent_device
+ - primary_ip
+ - site
+ - status
+ - url
+ DynamicGroup:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ 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
+ children:
+ type: array
+ items:
+ $ref: '#/components/schemas/NestedDynamicGroupMembership'
+ readOnly: true
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - children
+ - content_type
+ - created
+ - display
+ - filter
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - url
+ DynamicGroupMembership:
+ 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
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ group:
+ $ref: '#/components/schemas/NestedDynamicGroup'
+ parent_group:
+ $ref: '#/components/schemas/NestedDynamicGroup'
+ operator:
+ $ref: '#/components/schemas/OperatorEnum'
+ weight:
+ type: integer
+ maximum: 32767
+ minimum: 0
+ required:
+ - display
+ - group
+ - id
+ - operator
+ - parent_group
+ - url
+ - weight
+ DynamicGroupRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ 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
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - content_type
+ - filter
+ - name
+ ExportTemplate:
+ type: object
+ description: Extend ValidatedModelSerializer with a `relationships` field.
+ 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
+ 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 queryset.
+ mime_type:
+ type: string
+ description: Defaults to text/plain
+ maxLength: 50
+ file_extension:
+ type: string
+ description: Extension to append to the rendered filename
+ maxLength: 15
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ required:
+ - content_type
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - owner
+ - template_code
+ - url
+ ExportTemplateRequest:
+ type: object
+ description: Extend ValidatedModelSerializer with a `relationships` field.
+ properties:
+ content_type:
+ type: string
+ owner_content_type:
+ type: string
+ nullable: true
+ owner_object_id:
+ type: string
+ format: uuid
+ nullable: true
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ description:
+ type: string
+ maxLength: 200
+ template_code:
+ type: string
+ minLength: 1
+ description: The list of objects being exported is passed as a context variable
+ named queryset.
+ mime_type:
+ type: string
+ description: Defaults to text/plain
+ maxLength: 50
+ file_extension:
+ type: string
+ description: Extension to append to the rendered filename
+ maxLength: 15
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - content_type
+ - name
+ - template_code
+ FQDN:
+ type: object
+ description: FQDN Serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ ip_addresses:
+ type: array
+ items:
+ type: object
+ properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ family:
+ type: integer
+ readOnly: true
+ address:
+ type: string
+ required:
+ - address
+ - display
+ - family
+ - id
+ - url
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ description: Resolvable fully qualified domain name (e.g. networktocode.com)
+ maxLength: 254
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - url
+ FaceEnum:
+ type: string
+ enum:
+ - front
+ - rear
+ FailoverStrategyEnum:
+ type: string
+ enum:
+ - active-active
+ - active-passive
+ FeedLegEnum:
+ type: string
+ enum:
+ - A
+ - B
+ - C
+ FilterLogicEnum:
+ type: string
+ enum:
+ - disabled
+ - loose
+ - exact
+ FrontPort:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ 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
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - cable
+ - cable_peer
+ - cable_peer_type
+ - created
+ - device
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - url
+ FrontPortRearPortRequest:
+ type: object
+ description: NestedRearPortSerializer but with parent device omitted (since
+ front and rear ports must belong to same device)
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ label:
+ type: string
+ description: Physical label
+ maxLength: 64
+ required:
+ - id
+ FrontPortTemplate:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ 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
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - created
+ - device_type
+ - display
+ - id
+ - last_updated
+ - name
+ - rear_port
+ - type
+ - url
+ GitRepository:
+ type: object
+ description: Git repositories defined as a data source.
+ 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
+ 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
+ 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
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - remote_url
+ - url
+ GitRepositoryRequest:
+ type: object
+ description: Git repositories defined as a data source.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ remote_url:
+ type: string
+ format: uri
+ minLength: 1
+ description: Only HTTP and HTTPS URLs are presently supported
+ maxLength: 255
+ branch:
+ type: string
+ minLength: 1
+ maxLength: 64
+ token:
+ type: string
+ writeOnly: true
+ minLength: 1
+ username:
+ type: string
+ maxLength: 64
+ secrets_group:
+ allOf:
+ - $ref: '#/components/schemas/NestedSecretsGroupRequest'
+ 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'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - name
+ - remote_url
+ GoldenConfig:
+ type: object
+ description: Serializer for GoldenConfig object.
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: 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:
+ - created
+ - device
+ - display
+ - id
+ - last_updated
+ - url
+ GoldenConfigRequest:
+ type: object
+ description: Serializer for GoldenConfig object.
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _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:
+ - device
+ GoldenConfigSetting:
+ type: object
+ description: Serializer for GoldenConfigSetting object.
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ scope:
+ type: object
+ additionalProperties: {}
+ dynamic_group:
+ $ref: '#/components/schemas/NestedDynamicGroup'
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: 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.
+ 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:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - slug
+ - url
+ GrantTypeEnum:
+ enum:
+ - organization
+ - channel
+ - user
+ type: string
+ GraphQLAPIRequest:
+ type: object
+ properties:
+ query:
+ type: string
+ minLength: 1
+ 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
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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: {}
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - query
+ - url
+ GraphQLQueryInputRequest:
+ type: object
+ properties:
+ variables:
+ type: object
+ additionalProperties: {}
+ nullable: true
+ default: {}
+ GraphQLQueryOutput:
+ type: object
+ properties:
+ data:
+ type: object
+ additionalProperties: {}
+ default: {}
+ GraphQLQueryRequest:
+ 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:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ query:
+ type: string
+ minLength: 1
+ variables:
+ type: object
+ additionalProperties: {}
+ nullable: true
+ default: {}
+ required:
+ - name
+ - query
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ id:
+ type: integer
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ maxLength: 150
+ user_count:
+ type: integer
+ readOnly: true
+ required:
+ - display
+ - id
+ - name
+ - url
+ - user_count
+ GroupRequest:
+ 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:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 150
+ required:
+ - name
+ HardwareLCM:
+ type: object
+ description: API serializer.
+ properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ 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'
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ required:
+ - created
+ - device_type
+ - devices
+ - display
+ - expired
+ - id
+ - last_updated
+ - url
+ HttpMethodEnum:
+ enum:
+ - GET
+ - POST
+ - PUT
+ - PATCH
+ - DELETE
+ type: string
+ IPAddress:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ 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
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - address
+ - assigned_object
+ - created
+ - display
+ - family
+ - id
+ - last_updated
+ - nat_outside
+ - notes_url
+ - status
+ - url
+ IPAddressStatusChoices:
+ type: string
+ enum:
+ - active
+ - deprecated
+ - dhcp
+ - reserved
+ - slaac
+ IPRange:
+ type: object
+ description: IPRange Serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ start_address:
+ type: string
+ end_address:
+ type: string
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ size:
+ type: integer
+ readOnly: true
+ vrf:
+ type: string
+ format: uuid
+ nullable: true
+ required:
+ - created
+ - display
+ - end_address
+ - id
+ - last_updated
+ - notes_url
+ - size
+ - start_address
+ - url
+ IPRangeRequest:
+ type: object
+ description: IPRange Serializer.
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ start_address:
+ type: string
+ minLength: 1
+ end_address:
+ type: string
+ minLength: 1
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ vrf:
+ type: string
+ format: uuid
+ nullable: true
+ required:
+ - end_address
+ - start_address
+ 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
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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
+ required:
+ - content_type
+ - created
+ - display
+ - id
+ - image
+ - image_height
+ - image_width
+ - object_id
+ - parent
+ - url
+ ImageAttachmentRequest:
+ 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:
+ content_type:
+ type: string
+ object_id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ maxLength: 50
+ image:
+ type: string
+ format: binary
+ image_height:
+ type: integer
+ maximum: 32767
+ minimum: 0
+ image_width:
+ type: integer
+ maximum: 32767
+ minimum: 0
+ required:
+ - content_type
+ - image
+ - image_height
+ - image_width
+ - object_id
+ ImpactEnum:
+ enum:
+ - NO-IMPACT
+ - REDUCED-REDUNDANCY
+ - DEGRADED
+ - OUTAGE
+ type: string
+ Interface:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ device:
+ $ref: '#/components/schemas/NestedDevice'
+ name:
+ type: string
+ maxLength: 64
+ label:
+ type: string
+ description: Physical label
+ maxLength: 64
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioning
+ - failed
+ - maintenance
+ - planned
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioning
+ - Failed
+ - Maintenance
+ - Planned
+ type:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - virtual
+ - bridge
+ - 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
+ - Bridge
+ - 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
+ parent_interface:
+ allOf:
+ - $ref: '#/components/schemas/NestedInterface'
+ nullable: true
+ bridge:
+ allOf:
+ - $ref: '#/components/schemas/NestedInterface'
+ nullable: true
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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
+ 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
+ count_ipaddresses:
+ type: integer
+ readOnly: true
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - cable
+ - cable_peer
+ - cable_peer_type
+ - connected_endpoint
+ - connected_endpoint_reachable
+ - connected_endpoint_type
+ - count_ipaddresses
+ - created
+ - device
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - status
+ - 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:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ interface_a:
+ allOf:
+ - $ref: '#/components/schemas/NestedInterface'
+ readOnly: true
+ interface_b:
+ $ref: '#/components/schemas/NestedInterface'
+ connected_endpoint_reachable:
+ type: boolean
+ nullable: true
+ readOnly: true
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ required:
+ - connected_endpoint_reachable
+ - created
+ - display
+ - id
+ - interface_a
+ - interface_b
+ - last_updated
+ InterfaceSerializerVersion12:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ 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
+ - bridge
+ - 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
+ - Bridge
+ - 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
+ parent_interface:
+ allOf:
+ - $ref: '#/components/schemas/NestedInterface'
+ nullable: true
+ bridge:
+ allOf:
+ - $ref: '#/components/schemas/NestedInterface'
+ nullable: true
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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
+ 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
+ count_ipaddresses:
+ type: integer
+ readOnly: true
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - cable
+ - cable_peer
+ - cable_peer_type
+ - connected_endpoint
+ - connected_endpoint_reachable
+ - connected_endpoint_type
+ - count_ipaddresses
+ - created
+ - device
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - type
+ - url
+ InterfaceStatusChoices:
+ type: string
+ enum:
+ - active
+ - decommissioning
+ - failed
+ - maintenance
+ - planned
+ InterfaceTemplate:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ 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
+ - bridge
+ - 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
+ - Bridge
+ - 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
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - created
+ - device_type
+ - display
+ - id
+ - last_updated
+ - name
+ - type
+ - url
+ InterfaceTypeChoices:
+ type: string
+ enum:
+ - virtual
+ - bridge
+ - 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
+ InventoryItem:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ 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
+ _depth:
+ type: integer
+ readOnly: true
+ title: ' depth'
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - _depth
+ - created
+ - device
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - url
+ IpProtocolEnum:
+ enum:
+ - ICMP
+ - IGMP
+ - GGP
+ - TCP
+ - CBT
+ - EGP
+ - IGP
+ - BBN-RCC-MON
+ - NVP-II
+ - PUP
+ - EMCON
+ - XNET
+ - CHAOS
+ - UDP
+ - MUX
+ - DCN-MEAS
+ - HMP
+ - PRM
+ - XNS-IDP
+ - TRUNK-1
+ - TRUNK-2
+ - LEAF-1
+ - LEAF-2
+ - RDP
+ - IRTP
+ - ISO-TP4
+ - NETBLT
+ - MFE-NSP
+ - MERIT-INP
+ - DCCP
+ - 3PC
+ - IDPR
+ - XTP
+ - DDP
+ - IDPR-CMTP
+ - TP++
+ - IL
+ - SDRP
+ - IDRP
+ - RSVP
+ - GRE
+ - DSR
+ - BNA
+ - ESP
+ - AH
+ - I-NLSP
+ - NARP
+ - MOBILE
+ - TLSP
+ - SKIP
+ - CFTP
+ - SAT-EXPAK
+ - KRYPTOLAN
+ - RVD
+ - IPPC
+ - SAT-MON
+ - VISA
+ - IPCV
+ - CPNX
+ - CPHB
+ - WSN
+ - PVP
+ - BR-SAT-MON
+ - SUN-ND
+ - WB-MON
+ - WB-EXPAK
+ - ISO-IP
+ - VMTP
+ - SECURE-VMTP
+ - VINES
+ - TTP
+ - NSFNET-IGP
+ - DGP
+ - TCF
+ - EIGRP
+ - OSPFIGP
+ - Sprite-RPC
+ - LARP
+ - MTP
+ - AX.25
+ - IPIP
+ - SCC-SP
+ - ETHERIP
+ - ENCAP
+ - GMTP
+ - IFMP
+ - PNNI
+ - PIM
+ - ARIS
+ - SCPS
+ - QNX
+ - A/N
+ - IPComp
+ - SNP
+ - Compaq-Peer
+ - IPX-in-IP
+ - PGM
+ - L2TP
+ - DDX
+ - IATP
+ - STP
+ - SRP
+ - UTI
+ - SMP
+ - SM
+ - PTP
+ - FIRE
+ - CRTP
+ - CRUDP
+ - SSCOPMCE
+ - IPLT
+ - SPS
+ - PIPE
+ - SCTP
+ - FC
+ - RSVP-E2E-IGNORE
+ - UDPLite
+ - manet
+ - HIP
+ - WESP
+ - ROHC
+ - Ethernet
+ type: string
+ Job:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ 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
+ is_job_hook_receiver:
+ type: boolean
+ readOnly: true
+ description: Whether this job is a job hook receiver
+ has_sensitive_variables:
+ type: boolean
+ description: Whether this job contains sensitive variables
+ has_sensitive_variables_override:
+ type: boolean
+ description: If set, the configured value will remain even if the underlying
+ Job source code changes
+ 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 SoftTimeLimitExceeded
+ exception.
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.
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
+ task_queues:
+ type: object
+ additionalProperties: {}
+ description: Comma separated list of task queues that this job can run on.
+ A blank list will use the default queue
+ task_queues_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'
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - created
+ - display
+ - grouping
+ - id
+ - installed
+ - is_job_hook_receiver
+ - job_class_name
+ - last_updated
+ - module_name
+ - name
+ - notes_url
+ - 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
+ JobExecutionTypeIntervalChoices:
+ type: string
+ enum:
+ - immediately
+ - future
+ - hourly
+ - daily
+ - weekly
+ - custom
+ JobHook:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ maxLength: 100
+ content_types:
+ type: array
+ items:
+ type: string
+ job:
+ type: string
+ format: uuid
+ description: The job that this job hook will initiate
+ enabled:
+ type: boolean
+ type_create:
+ type: boolean
+ description: Call this job hook when a matching object is created.
+ type_update:
+ type: boolean
+ description: Call this job hook when a matching object is updated.
+ type_delete:
+ type: boolean
+ description: Call this job hook when a matching object is deleted.
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - content_types
+ - created
+ - display
+ - id
+ - job
+ - last_updated
+ - name
+ - notes_url
+ - url
+ JobHookRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ content_types:
+ type: array
+ items:
+ type: string
+ job:
+ type: string
+ format: uuid
+ description: The job that this job hook will initiate
+ enabled:
+ type: boolean
+ type_create:
+ type: boolean
+ description: Call this job hook when a matching object is created.
+ type_update:
+ type: boolean
+ description: Call this job hook when a matching object is updated.
+ type_delete:
+ type: boolean
+ description: Call this job hook when a matching object is deleted.
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - content_types
+ - job
+ - name
+ JobInputRequest:
+ type: object
+ properties:
+ data:
+ type: object
+ additionalProperties: {}
+ commit:
+ type: boolean
+ schedule:
+ $ref: '#/components/schemas/NestedScheduledJobRequest'
+ task_queue:
+ type: string
+ JobLogEntry:
+ 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.
+ - ensures that `id` field is always present on the serializer as well
+ - ensures that `created` and `last_updated` fields are always present if applicable to this model and serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ 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:
+ - display
+ - id
+ - job_result
+ - url
+ JobMultiPartInputRequest:
+ type: object
+ description: JobMultiPartInputSerializer is a "flattened" version of JobInputSerializer
+ for use with multipart/form-data submissions which only accept key-value pairs
+ properties:
+ _commit:
+ type: boolean
+ title: ' commit'
+ _schedule_name:
+ type: string
+ minLength: 1
+ title: ' schedule name'
+ maxLength: 255
+ _schedule_start_time:
+ type: string
+ format: date-time
+ title: ' schedule start time'
+ _schedule_interval:
+ allOf:
+ - $ref: '#/components/schemas/JobExecutionTypeIntervalChoices'
+ title: ' schedule interval'
+ _schedule_crontab:
+ type: string
+ title: ' schedule crontab'
+ _task_queue:
+ type: string
+ title: ' task queue'
+ JobRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ grouping:
+ type: string
+ minLength: 1
+ 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
+ minLength: 1
+ 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
+ enabled:
+ type: boolean
+ description: Whether this job can be executed by users
+ has_sensitive_variables:
+ type: boolean
+ description: Whether this job contains sensitive variables
+ has_sensitive_variables_override:
+ type: boolean
+ description: If set, the configured value will remain even if the underlying
+ Job source code changes
+ 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 SoftTimeLimitExceeded
+ exception.
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.
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
+ task_queues:
+ type: object
+ additionalProperties: {}
+ description: Comma separated list of task queues that this job can run on.
+ A blank list will use the default queue
+ task_queues_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/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - grouping
+ - name
+ JobResult:
+ type: object
+ description: Extends ModelSerializer to render any CustomFields and their values
+ associated with an object.
+ 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
+ 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
+ job_kwargs:
+ type: object
+ additionalProperties: {}
+ nullable: true
+ schedule:
+ allOf:
+ - $ref: '#/components/schemas/NestedScheduledJob'
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - created
+ - display
+ - id
+ - job_id
+ - job_model
+ - name
+ - obj_type
+ - schedule
+ - status
+ - url
+ - user
+ 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:
+ type: string
+ enum:
+ - m
+ - cm
+ - ft
+ - in
+ Location:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ 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
+ location_type:
+ $ref: '#/components/schemas/NestedLocationType'
+ parent:
+ allOf:
+ - $ref: '#/components/schemas/NestedLocation'
+ nullable: true
+ site:
+ allOf:
+ - $ref: '#/components/schemas/NestedSite'
+ nullable: true
+ tenant:
+ allOf:
+ - $ref: '#/components/schemas/NestedTenant'
+ nullable: true
+ description:
+ type: string
+ maxLength: 200
+ tree_depth:
+ type: integer
+ nullable: true
+ readOnly: true
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - location_type
+ - name
+ - notes_url
+ - status
+ - tree_depth
+ - url
+ LocationStatusChoices:
+ type: string
+ enum:
+ - active
+ - decommissioning
+ - planned
+ - retired
+ - staging
+ LocationType:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ name:
+ type: string
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ parent:
+ allOf:
+ - $ref: '#/components/schemas/NestedLocationType'
+ nullable: true
+ nestable:
+ type: boolean
+ description: Allow Locations of this type to be parents/children of other
+ Locations of this same type
+ content_types:
+ type: array
+ items:
+ type: string
+ description:
+ type: string
+ maxLength: 200
+ tree_depth:
+ type: integer
+ nullable: true
+ readOnly: true
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - tree_depth
+ - url
+ LogLevelEnum:
+ enum:
+ - default
+ - success
+ - info
+ - warning
+ - failure
+ type: string
+ Manufacturer:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ 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
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - created
+ - devicetype_count
+ - display
+ - id
+ - inventoryitem_count
+ - last_updated
+ - name
+ - notes_url
+ - platform_count
+ - url
+ ManufacturerRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - name
+ MinMaxValidationRule:
+ type: object
+ description: Serializer for `MinMaxValidationRule` objects.
+ properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ required:
+ - content_type
+ - created
+ - display
+ - field
+ - id
+ - last_updated
+ - name
+ - slug
+ - url
+ MinMaxValidationRuleRequest:
+ type: object
+ description: Serializer for `MinMaxValidationRule` objects.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ minLength: 1
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ content_type:
+ type: string
+ field:
+ type: string
+ minLength: 1
+ 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
+ required:
+ - content_type
+ - field
+ - name
+ - slug
+ ModeEnum:
+ type: string
+ enum:
+ - access
+ - tagged
+ - tagged-all
+ NATPolicy:
+ type: object
+ description: NATPolicy Serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ assigned_devices:
+ type: array
+ items:
+ $ref: '#/components/schemas/NATPolicyDeviceM2MNested'
+ assigned_dynamic_groups:
+ type: array
+ items:
+ $ref: '#/components/schemas/NATPolicyDynamicGroupM2MNested'
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ maxLength: 100
+ tenant:
+ type: string
+ format: uuid
+ nullable: true
+ nat_policy_rules:
+ type: array
+ items:
+ type: string
+ format: uuid
+ readOnly: true
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - nat_policy_rules
+ - notes_url
+ - url
+ NATPolicyDeviceM2MNested:
+ type: object
+ description: NATPolicyDeviceM2M NestedSerializer.
+ properties:
+ device:
+ type: string
+ format: uuid
+ weight:
+ type: integer
+ maximum: 32767
+ minimum: 0
+ required:
+ - device
+ NATPolicyDeviceM2MNestedRequest:
+ type: object
+ description: NATPolicyDeviceM2M NestedSerializer.
+ properties:
+ device:
+ type: string
+ format: uuid
+ weight:
+ type: integer
+ maximum: 32767
+ minimum: 0
+ required:
+ - id
+ NATPolicyDynamicGroupM2MNested:
+ type: object
+ description: NATPolicyDynamicGroupM2M NestedSerializer.
+ properties:
+ dynamic_group:
+ type: string
+ format: uuid
+ weight:
+ type: integer
+ maximum: 32767
+ minimum: 0
+ required:
+ - dynamic_group
+ NATPolicyDynamicGroupM2MNestedRequest:
+ type: object
+ description: NATPolicyDynamicGroupM2M NestedSerializer.
+ properties:
+ dynamic_group:
+ type: string
+ format: uuid
+ weight:
+ type: integer
+ maximum: 32767
+ minimum: 0
+ required:
+ - id
+ NATPolicyRequest:
+ type: object
+ description: NATPolicy Serializer.
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ assigned_devices:
+ type: array
+ items:
+ $ref: '#/components/schemas/NATPolicyDeviceM2MNestedRequest'
+ assigned_dynamic_groups:
+ type: array
+ items:
+ $ref: '#/components/schemas/NATPolicyDynamicGroupM2MNestedRequest'
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ tenant:
+ type: string
+ format: uuid
+ nullable: true
+ required:
+ - name
+ NATPolicyRule:
+ type: object
+ description: PolicyRule Serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ source_zone:
+ $ref: '#/components/schemas/Zone'
+ destination_zone:
+ $ref: '#/components/schemas/Zone'
+ original_source_addresses:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ ip_range:
+ $ref: '#/components/schemas/NestedIPRange'
+ fqdn:
+ $ref: '#/components/schemas/NestedFQDN'
+ ip_address:
+ $ref: '#/components/schemas/NestedIPAddress'
+ prefix:
+ $ref: '#/components/schemas/NestedPrefix'
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ description: Name descriptor for an address object type.
+ maxLength: 100
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - url
+ original_source_address_groups:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ address_objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ ip_range:
+ $ref: '#/components/schemas/NestedIPRange'
+ fqdn:
+ $ref: '#/components/schemas/NestedFQDN'
+ ip_address:
+ $ref: '#/components/schemas/NestedIPAddress'
+ prefix:
+ $ref: '#/components/schemas/NestedPrefix'
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ description: Name descriptor for an address object type.
+ maxLength: 100
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - url
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ description: Name descriptor for a group address objects.
+ maxLength: 100
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - url
+ original_source_services:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ description: Name of the service (e.g. HTTP)
+ maxLength: 100
+ port:
+ type: string
+ nullable: true
+ description: The port or port range to tie to a service (e.g. HTTP
+ would be port 80)
+ maxLength: 20
+ ip_protocol:
+ enum:
+ - ICMP
+ - IGMP
+ - GGP
+ - TCP
+ - CBT
+ - EGP
+ - IGP
+ - BBN-RCC-MON
+ - NVP-II
+ - PUP
+ - EMCON
+ - XNET
+ - CHAOS
+ - UDP
+ - MUX
+ - DCN-MEAS
+ - HMP
+ - PRM
+ - XNS-IDP
+ - TRUNK-1
+ - TRUNK-2
+ - LEAF-1
+ - LEAF-2
+ - RDP
+ - IRTP
+ - ISO-TP4
+ - NETBLT
+ - MFE-NSP
+ - MERIT-INP
+ - DCCP
+ - 3PC
+ - IDPR
+ - XTP
+ - DDP
+ - IDPR-CMTP
+ - TP++
+ - IL
+ - SDRP
+ - IDRP
+ - RSVP
+ - GRE
+ - DSR
+ - BNA
+ - ESP
+ - AH
+ - I-NLSP
+ - NARP
+ - MOBILE
+ - TLSP
+ - SKIP
+ - CFTP
+ - SAT-EXPAK
+ - KRYPTOLAN
+ - RVD
+ - IPPC
+ - SAT-MON
+ - VISA
+ - IPCV
+ - CPNX
+ - CPHB
+ - WSN
+ - PVP
+ - BR-SAT-MON
+ - SUN-ND
+ - WB-MON
+ - WB-EXPAK
+ - ISO-IP
+ - VMTP
+ - SECURE-VMTP
+ - VINES
+ - TTP
+ - NSFNET-IGP
+ - DGP
+ - TCF
+ - EIGRP
+ - OSPFIGP
+ - Sprite-RPC
+ - LARP
+ - MTP
+ - AX.25
+ - IPIP
+ - SCC-SP
+ - ETHERIP
+ - ENCAP
+ - GMTP
+ - IFMP
+ - PNNI
+ - PIM
+ - ARIS
+ - SCPS
+ - QNX
+ - A/N
+ - IPComp
+ - SNP
+ - Compaq-Peer
+ - IPX-in-IP
+ - PGM
+ - L2TP
+ - DDX
+ - IATP
+ - STP
+ - SRP
+ - UTI
+ - SMP
+ - SM
+ - PTP
+ - FIRE
+ - CRTP
+ - CRUDP
+ - SSCOPMCE
+ - IPLT
+ - SPS
+ - PIPE
+ - SCTP
+ - FC
+ - RSVP-E2E-IGNORE
+ - UDPLite
+ - manet
+ - HIP
+ - WESP
+ - ROHC
+ - Ethernet
+ type: string
+ description: IANA IP Protocol (e.g. TCP UDP ICMP)
+ required:
+ - created
+ - display
+ - id
+ - ip_protocol
+ - last_updated
+ - name
+ - notes_url
+ - url
+ original_source_service_groups:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ service_objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ description: Name of the service (e.g. HTTP)
+ maxLength: 100
+ port:
+ type: string
+ nullable: true
+ description: The port or port range to tie to a service (e.g.
+ HTTP would be port 80)
+ maxLength: 20
+ ip_protocol:
+ enum:
+ - ICMP
+ - IGMP
+ - GGP
+ - TCP
+ - CBT
+ - EGP
+ - IGP
+ - BBN-RCC-MON
+ - NVP-II
+ - PUP
+ - EMCON
+ - XNET
+ - CHAOS
+ - UDP
+ - MUX
+ - DCN-MEAS
+ - HMP
+ - PRM
+ - XNS-IDP
+ - TRUNK-1
+ - TRUNK-2
+ - LEAF-1
+ - LEAF-2
+ - RDP
+ - IRTP
+ - ISO-TP4
+ - NETBLT
+ - MFE-NSP
+ - MERIT-INP
+ - DCCP
+ - 3PC
+ - IDPR
+ - XTP
+ - DDP
+ - IDPR-CMTP
+ - TP++
+ - IL
+ - SDRP
+ - IDRP
+ - RSVP
+ - GRE
+ - DSR
+ - BNA
+ - ESP
+ - AH
+ - I-NLSP
+ - NARP
+ - MOBILE
+ - TLSP
+ - SKIP
+ - CFTP
+ - SAT-EXPAK
+ - KRYPTOLAN
+ - RVD
+ - IPPC
+ - SAT-MON
+ - VISA
+ - IPCV
+ - CPNX
+ - CPHB
+ - WSN
+ - PVP
+ - BR-SAT-MON
+ - SUN-ND
+ - WB-MON
+ - WB-EXPAK
+ - ISO-IP
+ - VMTP
+ - SECURE-VMTP
+ - VINES
+ - TTP
+ - NSFNET-IGP
+ - DGP
+ - TCF
+ - EIGRP
+ - OSPFIGP
+ - Sprite-RPC
+ - LARP
+ - MTP
+ - AX.25
+ - IPIP
+ - SCC-SP
+ - ETHERIP
+ - ENCAP
+ - GMTP
+ - IFMP
+ - PNNI
+ - PIM
+ - ARIS
+ - SCPS
+ - QNX
+ - A/N
+ - IPComp
+ - SNP
+ - Compaq-Peer
+ - IPX-in-IP
+ - PGM
+ - L2TP
+ - DDX
+ - IATP
+ - STP
+ - SRP
+ - UTI
+ - SMP
+ - SM
+ - PTP
+ - FIRE
+ - CRTP
+ - CRUDP
+ - SSCOPMCE
+ - IPLT
+ - SPS
+ - PIPE
+ - SCTP
+ - FC
+ - RSVP-E2E-IGNORE
+ - UDPLite
+ - manet
+ - HIP
+ - WESP
+ - ROHC
+ - Ethernet
+ type: string
+ description: IANA IP Protocol (e.g. TCP UDP ICMP)
+ required:
+ - created
+ - display
+ - id
+ - ip_protocol
+ - last_updated
+ - name
+ - notes_url
+ - url
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ maxLength: 100
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - url
+ translated_source_addresses:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ ip_range:
+ $ref: '#/components/schemas/NestedIPRange'
+ fqdn:
+ $ref: '#/components/schemas/NestedFQDN'
+ ip_address:
+ $ref: '#/components/schemas/NestedIPAddress'
+ prefix:
+ $ref: '#/components/schemas/NestedPrefix'
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ description: Name descriptor for an address object type.
+ maxLength: 100
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - url
+ translated_source_address_groups:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ address_objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ ip_range:
+ $ref: '#/components/schemas/NestedIPRange'
+ fqdn:
+ $ref: '#/components/schemas/NestedFQDN'
+ ip_address:
+ $ref: '#/components/schemas/NestedIPAddress'
+ prefix:
+ $ref: '#/components/schemas/NestedPrefix'
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ description: Name descriptor for an address object type.
+ maxLength: 100
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - url
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ description: Name descriptor for a group address objects.
+ maxLength: 100
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - url
+ translated_source_services:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ description: Name of the service (e.g. HTTP)
+ maxLength: 100
+ port:
+ type: string
+ nullable: true
+ description: The port or port range to tie to a service (e.g. HTTP
+ would be port 80)
+ maxLength: 20
+ ip_protocol:
+ enum:
+ - ICMP
+ - IGMP
+ - GGP
+ - TCP
+ - CBT
+ - EGP
+ - IGP
+ - BBN-RCC-MON
+ - NVP-II
+ - PUP
+ - EMCON
+ - XNET
+ - CHAOS
+ - UDP
+ - MUX
+ - DCN-MEAS
+ - HMP
+ - PRM
+ - XNS-IDP
+ - TRUNK-1
+ - TRUNK-2
+ - LEAF-1
+ - LEAF-2
+ - RDP
+ - IRTP
+ - ISO-TP4
+ - NETBLT
+ - MFE-NSP
+ - MERIT-INP
+ - DCCP
+ - 3PC
+ - IDPR
+ - XTP
+ - DDP
+ - IDPR-CMTP
+ - TP++
+ - IL
+ - SDRP
+ - IDRP
+ - RSVP
+ - GRE
+ - DSR
+ - BNA
+ - ESP
+ - AH
+ - I-NLSP
+ - NARP
+ - MOBILE
+ - TLSP
+ - SKIP
+ - CFTP
+ - SAT-EXPAK
+ - KRYPTOLAN
+ - RVD
+ - IPPC
+ - SAT-MON
+ - VISA
+ - IPCV
+ - CPNX
+ - CPHB
+ - WSN
+ - PVP
+ - BR-SAT-MON
+ - SUN-ND
+ - WB-MON
+ - WB-EXPAK
+ - ISO-IP
+ - VMTP
+ - SECURE-VMTP
+ - VINES
+ - TTP
+ - NSFNET-IGP
+ - DGP
+ - TCF
+ - EIGRP
+ - OSPFIGP
+ - Sprite-RPC
+ - LARP
+ - MTP
+ - AX.25
+ - IPIP
+ - SCC-SP
+ - ETHERIP
+ - ENCAP
+ - GMTP
+ - IFMP
+ - PNNI
+ - PIM
+ - ARIS
+ - SCPS
+ - QNX
+ - A/N
+ - IPComp
+ - SNP
+ - Compaq-Peer
+ - IPX-in-IP
+ - PGM
+ - L2TP
+ - DDX
+ - IATP
+ - STP
+ - SRP
+ - UTI
+ - SMP
+ - SM
+ - PTP
+ - FIRE
+ - CRTP
+ - CRUDP
+ - SSCOPMCE
+ - IPLT
+ - SPS
+ - PIPE
+ - SCTP
+ - FC
+ - RSVP-E2E-IGNORE
+ - UDPLite
+ - manet
+ - HIP
+ - WESP
+ - ROHC
+ - Ethernet
+ type: string
+ description: IANA IP Protocol (e.g. TCP UDP ICMP)
+ required:
+ - created
+ - display
+ - id
+ - ip_protocol
+ - last_updated
+ - name
+ - notes_url
+ - url
+ translated_source_service_groups:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ service_objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ description: Name of the service (e.g. HTTP)
+ maxLength: 100
+ port:
+ type: string
+ nullable: true
+ description: The port or port range to tie to a service (e.g.
+ HTTP would be port 80)
+ maxLength: 20
+ ip_protocol:
+ enum:
+ - ICMP
+ - IGMP
+ - GGP
+ - TCP
+ - CBT
+ - EGP
+ - IGP
+ - BBN-RCC-MON
+ - NVP-II
+ - PUP
+ - EMCON
+ - XNET
+ - CHAOS
+ - UDP
+ - MUX
+ - DCN-MEAS
+ - HMP
+ - PRM
+ - XNS-IDP
+ - TRUNK-1
+ - TRUNK-2
+ - LEAF-1
+ - LEAF-2
+ - RDP
+ - IRTP
+ - ISO-TP4
+ - NETBLT
+ - MFE-NSP
+ - MERIT-INP
+ - DCCP
+ - 3PC
+ - IDPR
+ - XTP
+ - DDP
+ - IDPR-CMTP
+ - TP++
+ - IL
+ - SDRP
+ - IDRP
+ - RSVP
+ - GRE
+ - DSR
+ - BNA
+ - ESP
+ - AH
+ - I-NLSP
+ - NARP
+ - MOBILE
+ - TLSP
+ - SKIP
+ - CFTP
+ - SAT-EXPAK
+ - KRYPTOLAN
+ - RVD
+ - IPPC
+ - SAT-MON
+ - VISA
+ - IPCV
+ - CPNX
+ - CPHB
+ - WSN
+ - PVP
+ - BR-SAT-MON
+ - SUN-ND
+ - WB-MON
+ - WB-EXPAK
+ - ISO-IP
+ - VMTP
+ - SECURE-VMTP
+ - VINES
+ - TTP
+ - NSFNET-IGP
+ - DGP
+ - TCF
+ - EIGRP
+ - OSPFIGP
+ - Sprite-RPC
+ - LARP
+ - MTP
+ - AX.25
+ - IPIP
+ - SCC-SP
+ - ETHERIP
+ - ENCAP
+ - GMTP
+ - IFMP
+ - PNNI
+ - PIM
+ - ARIS
+ - SCPS
+ - QNX
+ - A/N
+ - IPComp
+ - SNP
+ - Compaq-Peer
+ - IPX-in-IP
+ - PGM
+ - L2TP
+ - DDX
+ - IATP
+ - STP
+ - SRP
+ - UTI
+ - SMP
+ - SM
+ - PTP
+ - FIRE
+ - CRTP
+ - CRUDP
+ - SSCOPMCE
+ - IPLT
+ - SPS
+ - PIPE
+ - SCTP
+ - FC
+ - RSVP-E2E-IGNORE
+ - UDPLite
+ - manet
+ - HIP
+ - WESP
+ - ROHC
+ - Ethernet
+ type: string
+ description: IANA IP Protocol (e.g. TCP UDP ICMP)
+ required:
+ - created
+ - display
+ - id
+ - ip_protocol
+ - last_updated
+ - name
+ - notes_url
+ - url
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ maxLength: 100
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - url
+ original_destination_addresses:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ ip_range:
+ $ref: '#/components/schemas/NestedIPRange'
+ fqdn:
+ $ref: '#/components/schemas/NestedFQDN'
+ ip_address:
+ $ref: '#/components/schemas/NestedIPAddress'
+ prefix:
+ $ref: '#/components/schemas/NestedPrefix'
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ description: Name descriptor for an address object type.
+ maxLength: 100
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - url
+ original_destination_address_groups:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ address_objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ ip_range:
+ $ref: '#/components/schemas/NestedIPRange'
+ fqdn:
+ $ref: '#/components/schemas/NestedFQDN'
+ ip_address:
+ $ref: '#/components/schemas/NestedIPAddress'
+ prefix:
+ $ref: '#/components/schemas/NestedPrefix'
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ description: Name descriptor for an address object type.
+ maxLength: 100
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - url
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ description: Name descriptor for a group address objects.
+ maxLength: 100
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - url
+ original_destination_services:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ description: Name of the service (e.g. HTTP)
+ maxLength: 100
+ port:
+ type: string
+ nullable: true
+ description: The port or port range to tie to a service (e.g. HTTP
+ would be port 80)
+ maxLength: 20
+ ip_protocol:
+ enum:
+ - ICMP
+ - IGMP
+ - GGP
+ - TCP
+ - CBT
+ - EGP
+ - IGP
+ - BBN-RCC-MON
+ - NVP-II
+ - PUP
+ - EMCON
+ - XNET
+ - CHAOS
+ - UDP
+ - MUX
+ - DCN-MEAS
+ - HMP
+ - PRM
+ - XNS-IDP
+ - TRUNK-1
+ - TRUNK-2
+ - LEAF-1
+ - LEAF-2
+ - RDP
+ - IRTP
+ - ISO-TP4
+ - NETBLT
+ - MFE-NSP
+ - MERIT-INP
+ - DCCP
+ - 3PC
+ - IDPR
+ - XTP
+ - DDP
+ - IDPR-CMTP
+ - TP++
+ - IL
+ - SDRP
+ - IDRP
+ - RSVP
+ - GRE
+ - DSR
+ - BNA
+ - ESP
+ - AH
+ - I-NLSP
+ - NARP
+ - MOBILE
+ - TLSP
+ - SKIP
+ - CFTP
+ - SAT-EXPAK
+ - KRYPTOLAN
+ - RVD
+ - IPPC
+ - SAT-MON
+ - VISA
+ - IPCV
+ - CPNX
+ - CPHB
+ - WSN
+ - PVP
+ - BR-SAT-MON
+ - SUN-ND
+ - WB-MON
+ - WB-EXPAK
+ - ISO-IP
+ - VMTP
+ - SECURE-VMTP
+ - VINES
+ - TTP
+ - NSFNET-IGP
+ - DGP
+ - TCF
+ - EIGRP
+ - OSPFIGP
+ - Sprite-RPC
+ - LARP
+ - MTP
+ - AX.25
+ - IPIP
+ - SCC-SP
+ - ETHERIP
+ - ENCAP
+ - GMTP
+ - IFMP
+ - PNNI
+ - PIM
+ - ARIS
+ - SCPS
+ - QNX
+ - A/N
+ - IPComp
+ - SNP
+ - Compaq-Peer
+ - IPX-in-IP
+ - PGM
+ - L2TP
+ - DDX
+ - IATP
+ - STP
+ - SRP
+ - UTI
+ - SMP
+ - SM
+ - PTP
+ - FIRE
+ - CRTP
+ - CRUDP
+ - SSCOPMCE
+ - IPLT
+ - SPS
+ - PIPE
+ - SCTP
+ - FC
+ - RSVP-E2E-IGNORE
+ - UDPLite
+ - manet
+ - HIP
+ - WESP
+ - ROHC
+ - Ethernet
+ type: string
+ description: IANA IP Protocol (e.g. TCP UDP ICMP)
+ required:
+ - created
+ - display
+ - id
+ - ip_protocol
+ - last_updated
+ - name
+ - notes_url
+ - url
+ original_destination_service_groups:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ service_objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ description: Name of the service (e.g. HTTP)
+ maxLength: 100
+ port:
+ type: string
+ nullable: true
+ description: The port or port range to tie to a service (e.g.
+ HTTP would be port 80)
+ maxLength: 20
+ ip_protocol:
+ enum:
+ - ICMP
+ - IGMP
+ - GGP
+ - TCP
+ - CBT
+ - EGP
+ - IGP
+ - BBN-RCC-MON
+ - NVP-II
+ - PUP
+ - EMCON
+ - XNET
+ - CHAOS
+ - UDP
+ - MUX
+ - DCN-MEAS
+ - HMP
+ - PRM
+ - XNS-IDP
+ - TRUNK-1
+ - TRUNK-2
+ - LEAF-1
+ - LEAF-2
+ - RDP
+ - IRTP
+ - ISO-TP4
+ - NETBLT
+ - MFE-NSP
+ - MERIT-INP
+ - DCCP
+ - 3PC
+ - IDPR
+ - XTP
+ - DDP
+ - IDPR-CMTP
+ - TP++
+ - IL
+ - SDRP
+ - IDRP
+ - RSVP
+ - GRE
+ - DSR
+ - BNA
+ - ESP
+ - AH
+ - I-NLSP
+ - NARP
+ - MOBILE
+ - TLSP
+ - SKIP
+ - CFTP
+ - SAT-EXPAK
+ - KRYPTOLAN
+ - RVD
+ - IPPC
+ - SAT-MON
+ - VISA
+ - IPCV
+ - CPNX
+ - CPHB
+ - WSN
+ - PVP
+ - BR-SAT-MON
+ - SUN-ND
+ - WB-MON
+ - WB-EXPAK
+ - ISO-IP
+ - VMTP
+ - SECURE-VMTP
+ - VINES
+ - TTP
+ - NSFNET-IGP
+ - DGP
+ - TCF
+ - EIGRP
+ - OSPFIGP
+ - Sprite-RPC
+ - LARP
+ - MTP
+ - AX.25
+ - IPIP
+ - SCC-SP
+ - ETHERIP
+ - ENCAP
+ - GMTP
+ - IFMP
+ - PNNI
+ - PIM
+ - ARIS
+ - SCPS
+ - QNX
+ - A/N
+ - IPComp
+ - SNP
+ - Compaq-Peer
+ - IPX-in-IP
+ - PGM
+ - L2TP
+ - DDX
+ - IATP
+ - STP
+ - SRP
+ - UTI
+ - SMP
+ - SM
+ - PTP
+ - FIRE
+ - CRTP
+ - CRUDP
+ - SSCOPMCE
+ - IPLT
+ - SPS
+ - PIPE
+ - SCTP
+ - FC
+ - RSVP-E2E-IGNORE
+ - UDPLite
+ - manet
+ - HIP
+ - WESP
+ - ROHC
+ - Ethernet
+ type: string
+ description: IANA IP Protocol (e.g. TCP UDP ICMP)
+ required:
+ - created
+ - display
+ - id
+ - ip_protocol
+ - last_updated
+ - name
+ - notes_url
+ - url
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ maxLength: 100
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - url
+ translated_destination_addresses:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ ip_range:
+ $ref: '#/components/schemas/NestedIPRange'
+ fqdn:
+ $ref: '#/components/schemas/NestedFQDN'
+ ip_address:
+ $ref: '#/components/schemas/NestedIPAddress'
+ prefix:
+ $ref: '#/components/schemas/NestedPrefix'
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ description: Name descriptor for an address object type.
+ maxLength: 100
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - url
+ translated_destination_address_groups:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ address_objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ ip_range:
+ $ref: '#/components/schemas/NestedIPRange'
+ fqdn:
+ $ref: '#/components/schemas/NestedFQDN'
+ ip_address:
+ $ref: '#/components/schemas/NestedIPAddress'
+ prefix:
+ $ref: '#/components/schemas/NestedPrefix'
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ description: Name descriptor for an address object type.
+ maxLength: 100
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - url
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ description: Name descriptor for a group address objects.
+ maxLength: 100
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - url
+ translated_destination_services:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ description: Name of the service (e.g. HTTP)
+ maxLength: 100
+ port:
+ type: string
+ nullable: true
+ description: The port or port range to tie to a service (e.g. HTTP
+ would be port 80)
+ maxLength: 20
+ ip_protocol:
+ enum:
+ - ICMP
+ - IGMP
+ - GGP
+ - TCP
+ - CBT
+ - EGP
+ - IGP
+ - BBN-RCC-MON
+ - NVP-II
+ - PUP
+ - EMCON
+ - XNET
+ - CHAOS
+ - UDP
+ - MUX
+ - DCN-MEAS
+ - HMP
+ - PRM
+ - XNS-IDP
+ - TRUNK-1
+ - TRUNK-2
+ - LEAF-1
+ - LEAF-2
+ - RDP
+ - IRTP
+ - ISO-TP4
+ - NETBLT
+ - MFE-NSP
+ - MERIT-INP
+ - DCCP
+ - 3PC
+ - IDPR
+ - XTP
+ - DDP
+ - IDPR-CMTP
+ - TP++
+ - IL
+ - SDRP
+ - IDRP
+ - RSVP
+ - GRE
+ - DSR
+ - BNA
+ - ESP
+ - AH
+ - I-NLSP
+ - NARP
+ - MOBILE
+ - TLSP
+ - SKIP
+ - CFTP
+ - SAT-EXPAK
+ - KRYPTOLAN
+ - RVD
+ - IPPC
+ - SAT-MON
+ - VISA
+ - IPCV
+ - CPNX
+ - CPHB
+ - WSN
+ - PVP
+ - BR-SAT-MON
+ - SUN-ND
+ - WB-MON
+ - WB-EXPAK
+ - ISO-IP
+ - VMTP
+ - SECURE-VMTP
+ - VINES
+ - TTP
+ - NSFNET-IGP
+ - DGP
+ - TCF
+ - EIGRP
+ - OSPFIGP
+ - Sprite-RPC
+ - LARP
+ - MTP
+ - AX.25
+ - IPIP
+ - SCC-SP
+ - ETHERIP
+ - ENCAP
+ - GMTP
+ - IFMP
+ - PNNI
+ - PIM
+ - ARIS
+ - SCPS
+ - QNX
+ - A/N
+ - IPComp
+ - SNP
+ - Compaq-Peer
+ - IPX-in-IP
+ - PGM
+ - L2TP
+ - DDX
+ - IATP
+ - STP
+ - SRP
+ - UTI
+ - SMP
+ - SM
+ - PTP
+ - FIRE
+ - CRTP
+ - CRUDP
+ - SSCOPMCE
+ - IPLT
+ - SPS
+ - PIPE
+ - SCTP
+ - FC
+ - RSVP-E2E-IGNORE
+ - UDPLite
+ - manet
+ - HIP
+ - WESP
+ - ROHC
+ - Ethernet
+ type: string
+ description: IANA IP Protocol (e.g. TCP UDP ICMP)
+ required:
+ - created
+ - display
+ - id
+ - ip_protocol
+ - last_updated
+ - name
+ - notes_url
+ - url
+ translated_destination_service_groups:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ service_objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ description: Name of the service (e.g. HTTP)
+ maxLength: 100
+ port:
+ type: string
+ nullable: true
+ description: The port or port range to tie to a service (e.g.
+ HTTP would be port 80)
+ maxLength: 20
+ ip_protocol:
+ enum:
+ - ICMP
+ - IGMP
+ - GGP
+ - TCP
+ - CBT
+ - EGP
+ - IGP
+ - BBN-RCC-MON
+ - NVP-II
+ - PUP
+ - EMCON
+ - XNET
+ - CHAOS
+ - UDP
+ - MUX
+ - DCN-MEAS
+ - HMP
+ - PRM
+ - XNS-IDP
+ - TRUNK-1
+ - TRUNK-2
+ - LEAF-1
+ - LEAF-2
+ - RDP
+ - IRTP
+ - ISO-TP4
+ - NETBLT
+ - MFE-NSP
+ - MERIT-INP
+ - DCCP
+ - 3PC
+ - IDPR
+ - XTP
+ - DDP
+ - IDPR-CMTP
+ - TP++
+ - IL
+ - SDRP
+ - IDRP
+ - RSVP
+ - GRE
+ - DSR
+ - BNA
+ - ESP
+ - AH
+ - I-NLSP
+ - NARP
+ - MOBILE
+ - TLSP
+ - SKIP
+ - CFTP
+ - SAT-EXPAK
+ - KRYPTOLAN
+ - RVD
+ - IPPC
+ - SAT-MON
+ - VISA
+ - IPCV
+ - CPNX
+ - CPHB
+ - WSN
+ - PVP
+ - BR-SAT-MON
+ - SUN-ND
+ - WB-MON
+ - WB-EXPAK
+ - ISO-IP
+ - VMTP
+ - SECURE-VMTP
+ - VINES
+ - TTP
+ - NSFNET-IGP
+ - DGP
+ - TCF
+ - EIGRP
+ - OSPFIGP
+ - Sprite-RPC
+ - LARP
+ - MTP
+ - AX.25
+ - IPIP
+ - SCC-SP
+ - ETHERIP
+ - ENCAP
+ - GMTP
+ - IFMP
+ - PNNI
+ - PIM
+ - ARIS
+ - SCPS
+ - QNX
+ - A/N
+ - IPComp
+ - SNP
+ - Compaq-Peer
+ - IPX-in-IP
+ - PGM
+ - L2TP
+ - DDX
+ - IATP
+ - STP
+ - SRP
+ - UTI
+ - SMP
+ - SM
+ - PTP
+ - FIRE
+ - CRTP
+ - CRUDP
+ - SSCOPMCE
+ - IPLT
+ - SPS
+ - PIPE
+ - SCTP
+ - FC
+ - RSVP-E2E-IGNORE
+ - UDPLite
+ - manet
+ - HIP
+ - WESP
+ - ROHC
+ - Ethernet
+ type: string
+ description: IANA IP Protocol (e.g. TCP UDP ICMP)
+ required:
+ - created
+ - display
+ - id
+ - ip_protocol
+ - last_updated
+ - name
+ - notes_url
+ - url
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ maxLength: 100
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - url
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ name:
+ type: string
+ maxLength: 100
+ remark:
+ type: boolean
+ log:
+ type: boolean
+ request_id:
+ type: string
+ nullable: true
+ maxLength: 100
+ description:
+ type: string
+ nullable: true
+ maxLength: 200
+ index:
+ type: integer
+ maximum: 32767
+ minimum: 0
+ nullable: true
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - url
+ NestedAutonomousSystem:
+ type: object
+ description: Nested/brief serializer for AutonomousSystem.
+ properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ asn:
+ type: integer
+ maximum: 4294967295
+ minimum: 1
+ format: int64
+ description: 32-bit autonomous system number
+ required:
+ - asn
+ - display
+ - id
+ - url
+ NestedAutonomousSystemRequest:
+ type: object
+ description: Nested/brief serializer for AutonomousSystem.
+ properties:
+ asn:
+ type: integer
+ maximum: 4294967295
+ minimum: 1
+ format: int64
+ description: 32-bit autonomous system number
+ required:
+ - id
+ 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:
+ $ref: '#/components/schemas/SeverityEnum'
+ 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
+ NestedCVELCMRequest:
+ type: object
+ description: Nested serializer for the CVE class.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 16
+ published_date:
+ type: string
+ format: date
+ link:
+ type: string
+ format: uri
+ minLength: 1
+ maxLength: 200
+ status:
+ type: string
+ format: uuid
+ nullable: true
+ description:
+ type: string
+ nullable: true
+ maxLength: 255
+ severity:
+ $ref: '#/components/schemas/SeverityEnum'
+ 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:
+ - id
+ 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.
+ - ensures that `id` field is always present on the serializer as well
+ - ensures that `created` and `last_updated` fields are always present if applicable to this model and serializer.
+ properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ label:
+ type: string
+ maxLength: 100
+ required:
+ - display
+ - id
+ - url
+ NestedCableRequest:
+ 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.
+ - ensures that `id` field is always present on the serializer as well
+ - ensures that `created` and `last_updated` fields are always present if applicable to this model and serializer.
+ properties:
+ label:
+ type: string
+ maxLength: 100
+ required:
+ - id
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ cid:
+ type: string
+ title: Circuit ID
+ maxLength: 100
+ required:
+ - cid
+ - display
+ - id
+ - url
+ NestedCircuitRequest:
+ 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:
+ cid:
+ type: string
+ minLength: 1
+ title: Circuit ID
+ maxLength: 100
+ required:
+ - id
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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
+ required:
+ - circuit_count
+ - display
+ - id
+ - name
+ - url
+ NestedCircuitTypeRequest:
+ 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:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ required:
+ - id
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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
+ required:
+ - cluster_count
+ - display
+ - id
+ - name
+ - url
+ NestedClusterGroupRequest:
+ 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:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ required:
+ - id
+ NestedClusterRequest:
+ 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:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ required:
+ - id
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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
+ required:
+ - cluster_count
+ - display
+ - id
+ - name
+ - url
+ NestedClusterTypeRequest:
+ 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:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ required:
+ - id
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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_]+$
+ required:
+ - display
+ - id
+ - name
+ - url
+ NestedConfigContextSchemaRequest:
+ 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:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 200
+ slug:
+ type: string
+ maxLength: 200
+ pattern: ^[-a-zA-Z0-9_]+$
+ required:
+ - id
+ NestedContractLCM:
+ type: object
+ description: API serializer.
+ properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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
+ required:
+ - display
+ - expired
+ - id
+ - name
+ - provider
+ NestedContractLCMRequest:
+ type: object
+ description: API serializer.
+ properties:
+ provider:
+ allOf:
+ - $ref: '#/components/schemas/NestedProviderLCMRequest'
+ description: Contract Provider
+ name:
+ type: string
+ minLength: 1
+ 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
+ required:
+ - id
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ description: Human-readable unique name of this field.
+ maxLength: 50
+ required:
+ - display
+ - id
+ - name
+ - url
+ NestedCustomFieldRequest:
+ 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:
+ name:
+ type: string
+ minLength: 1
+ description: Human-readable unique name of this field.
+ maxLength: 50
+ required:
+ - id
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ nullable: true
+ maxLength: 64
+ required:
+ - display
+ - id
+ - url
+ NestedDeviceRedundancyGroup:
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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_]+$
+ failover_strategy:
+ oneOf:
+ - $ref: '#/components/schemas/FailoverStrategyEnum'
+ - $ref: '#/components/schemas/BlankEnum'
+ required:
+ - display
+ - id
+ - name
+ - url
+ NestedDeviceRedundancyGroupRequest:
+ 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:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ failover_strategy:
+ oneOf:
+ - $ref: '#/components/schemas/FailoverStrategyEnum'
+ - $ref: '#/components/schemas/BlankEnum'
+ required:
+ - id
+ NestedDeviceRequest:
+ 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:
+ name:
+ type: string
+ nullable: true
+ maxLength: 64
+ required:
+ - id
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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
+ required:
+ - device_count
+ - display
+ - id
+ - name
+ - url
+ - virtualmachine_count
+ NestedDeviceRoleRequest:
+ 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:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ required:
+ - id
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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
+ required:
+ - device_count
+ - display
+ - id
+ - manufacturer
+ - model
+ - slug
+ - url
+ NestedDeviceTypeRequest:
+ 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:
+ model:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ required:
+ - id
+ NestedDynamicGroup:
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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_]+$
+ content_type:
+ type: string
+ required:
+ - content_type
+ - display
+ - id
+ - name
+ - url
+ NestedDynamicGroupMembership:
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ group:
+ $ref: '#/components/schemas/NestedDynamicGroup'
+ parent_group:
+ $ref: '#/components/schemas/NestedDynamicGroup'
+ operator:
+ $ref: '#/components/schemas/OperatorEnum'
+ weight:
+ type: integer
+ maximum: 32767
+ minimum: 0
+ required:
+ - display
+ - group
+ - id
+ - operator
+ - parent_group
+ - url
+ - weight
+ NestedDynamicGroupMembershipRequest:
+ 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:
+ group:
+ $ref: '#/components/schemas/NestedDynamicGroupRequest'
+ parent_group:
+ $ref: '#/components/schemas/NestedDynamicGroupRequest'
+ operator:
+ $ref: '#/components/schemas/OperatorEnum'
+ weight:
+ type: integer
+ maximum: 32767
+ minimum: 0
+ required:
+ - id
+ NestedDynamicGroupRequest:
+ 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:
+ name:
+ type: string
+ minLength: 1
+ description: Dynamic Group name
+ maxLength: 100
+ slug:
+ type: string
+ description: Unique slug
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ content_type:
+ type: string
+ required:
+ - id
+ NestedFQDN:
+ type: object
+ description: Nested serializer for FQDN.
+ properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ description: Resolvable fully qualified domain name (e.g. networktocode.com)
+ maxLength: 254
+ required:
+ - display
+ - id
+ - name
+ - url
+ NestedFQDNRequest:
+ type: object
+ description: Nested serializer for FQDN.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ description: Resolvable fully qualified domain name (e.g. networktocode.com)
+ maxLength: 254
+ required:
+ - id
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ family:
+ type: integer
+ readOnly: true
+ address:
+ type: string
+ required:
+ - address
+ - display
+ - family
+ - id
+ - url
+ NestedIPAddressRequest:
+ 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:
+ address:
+ type: string
+ minLength: 1
+ required:
+ - id
+ NestedIPRange:
+ type: object
+ description: Nested serializer for IPRange.
+ properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ start_address:
+ type: string
+ end_address:
+ type: string
+ required:
+ - display
+ - end_address
+ - id
+ - start_address
+ - url
+ NestedIPRangeRequest:
+ type: object
+ description: Nested serializer for IPRange.
+ properties:
+ start_address:
+ type: string
+ minLength: 1
+ end_address:
+ type: string
+ minLength: 1
+ required:
+ - id
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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
+ required:
+ - device
+ - display
+ - id
+ - name
+ - url
+ NestedInterfaceRequest:
+ 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:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ cable:
+ type: string
+ format: uuid
+ nullable: true
+ required:
+ - id
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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'
+ required:
+ - _depth
+ - device
+ - display
+ - id
+ - name
+ - url
+ NestedInventoryItemRequest:
+ 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:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ required:
+ - id
+ NestedJob:
+ 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.
+ - ensures that `id` field is always present on the serializer as well
+ - ensures that `created` and `last_updated` fields are always present if applicable to this model and serializer.
+ properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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:
+ - display
+ - grouping
+ - id
+ - job_class_name
+ - module_name
+ - name
+ - source
+ - url
+ NestedJobResult:
+ 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.
+ - ensures that `id` field is always present on the serializer as well
+ - ensures that `created` and `last_updated` fields are always present if applicable to this model and serializer.
+ properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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
+ - display
+ - id
+ - name
+ - status
+ - url
+ - user
+ NestedLocation:
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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_]+$
+ tree_depth:
+ type: integer
+ nullable: true
+ readOnly: true
+ required:
+ - display
+ - id
+ - name
+ - tree_depth
+ - url
+ NestedLocationRequest:
+ 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:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ required:
+ - id
+ NestedLocationType:
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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_]+$
+ tree_depth:
+ type: integer
+ nullable: true
+ readOnly: true
+ required:
+ - display
+ - id
+ - name
+ - tree_depth
+ - url
+ NestedLocationTypeRequest:
+ 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:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ required:
+ - id
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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
+ required:
+ - devicetype_count
+ - display
+ - id
+ - name
+ - url
+ NestedManufacturerRequest:
+ 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:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ required:
+ - id
+ NestedPeerEndpoint:
+ type: object
+ description: Nested/brief serializer for PeerEndpoint.
+ properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ required:
+ - display
+ - id
+ - url
+ NestedPeerGroup:
+ type: object
+ description: Nested/brief serializer for PeerGroup.
+ properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ maxLength: 100
+ role:
+ type: string
+ format: uuid
+ nullable: true
+ enabled:
+ type: boolean
+ required:
+ - display
+ - id
+ - name
+ - url
+ NestedPeerGroupRequest:
+ type: object
+ description: Nested/brief serializer for PeerGroup.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ role:
+ type: string
+ format: uuid
+ nullable: true
+ enabled:
+ type: boolean
+ required:
+ - id
+ NestedPeerGroupTemplate:
+ type: object
+ description: Nested/brief serializer for PeerGroup.
+ properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ maxLength: 100
+ role:
+ type: string
+ format: uuid
+ nullable: true
+ enabled:
+ type: boolean
+ required:
+ - display
+ - id
+ - name
+ - url
+ NestedPeerGroupTemplateRequest:
+ type: object
+ description: Nested/brief serializer for PeerGroup.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ role:
+ type: string
+ format: uuid
+ nullable: true
+ enabled:
+ type: boolean
+ required:
+ - id
+ NestedPeering:
+ type: object
+ description: Nested/brief serializer for Peering.
+ properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ status:
+ type: string
+ format: uuid
+ nullable: true
+ required:
+ - display
+ - id
+ - url
+ NestedPeeringRequest:
+ type: object
+ description: Nested/brief serializer for Peering.
+ properties:
+ status:
+ type: string
+ format: uuid
+ nullable: true
+ required:
+ - id
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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
+ required:
+ - device_count
+ - display
+ - id
+ - name
+ - url
+ - virtualmachine_count
+ NestedPlatformRequest:
+ 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:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ required:
+ - id
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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
+ required:
+ - display
+ - id
+ - name
+ - powerfeed_count
+ - url
+ NestedPowerPanelRequest:
+ 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:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ required:
+ - id
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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
+ required:
+ - device
+ - display
+ - id
+ - name
+ - url
+ NestedPowerPortRequest:
+ 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:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ cable:
+ type: string
+ format: uuid
+ nullable: true
+ required:
+ - id
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ maxLength: 64
+ required:
+ - display
+ - id
+ - name
+ - url
+ NestedPowerPortTemplateRequest:
+ 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:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ required:
+ - id
+ NestedPrefix:
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ family:
+ type: integer
+ readOnly: true
+ prefix:
+ type: string
+ required:
+ - display
+ - family
+ - id
+ - prefix
+ - url
+ NestedPrefixRequest:
+ 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:
+ prefix:
+ type: string
+ minLength: 1
+ required:
+ - id
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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
+ required:
+ - circuit_count
+ - display
+ - id
+ - name
+ - url
+ NestedProviderLCM:
+ type: object
+ description: Nested serializer for the provider class.
+ properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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
+ required:
+ - display
+ - id
+ - name
+ NestedProviderLCMRequest:
+ type: object
+ description: Nested serializer for the provider class.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ 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
+ required:
+ - id
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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_]+$
+ required:
+ - display
+ - id
+ - name
+ - url
+ NestedProviderNetworkRequest:
+ 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:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ required:
+ - id
+ NestedProviderRequest:
+ 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:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ required:
+ - id
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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
+ required:
+ - aggregate_count
+ - display
+ - id
+ - name
+ - url
+ NestedRIRRequest:
+ 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:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ required:
+ - id
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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'
+ required:
+ - _depth
+ - display
+ - id
+ - name
+ - rack_count
+ - url
+ NestedRackGroupRequest:
+ 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:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ required:
+ - id
+ NestedRackRequest:
+ 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:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ required:
+ - id
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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
+ required:
+ - display
+ - id
+ - name
+ - rack_count
+ - url
+ NestedRackRoleRequest:
+ 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:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ required:
+ - id
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ maxLength: 64
+ required:
+ - display
+ - id
+ - name
+ - url
+ NestedRearPortTemplateRequest:
+ 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:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ required:
+ - id
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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'
+ required:
+ - _depth
+ - display
+ - id
+ - name
+ - site_count
+ - url
+ NestedRegionRequest:
+ 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:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ required:
+ - id
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ description: Name of the relationship as displayed to users
+ maxLength: 100
+ slug:
+ type: string
+ description: Internal relationship name. Please use underscores rather than
+ dashes in this slug.
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ required:
+ - display
+ - id
+ - name
+ - url
+ NestedRelationshipRequest:
+ 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:
+ name:
+ type: string
+ minLength: 1
+ description: Name of the relationship as displayed to users
+ maxLength: 100
+ slug:
+ type: string
+ description: Internal relationship name. Please use underscores rather than
+ dashes in this slug.
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ required:
+ - id
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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
+ required:
+ - display
+ - id
+ - name
+ - prefix_count
+ - url
+ - vlan_count
+ NestedRoleRequest:
+ 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:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ required:
+ - id
+ NestedRoutingInstance:
+ type: object
+ description: Nested/brief serializer for PeerEndpoint.
+ properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ required:
+ - display
+ - id
+ - url
+ NestedScheduledJob:
+ 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.
+ - ensures that `id` field is always present on the serializer as well
+ - ensures that `created` and `last_updated` fields are always present if applicable to this model and serializer.
+ 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
+ name:
+ type: string
+ maxLength: 255
+ start_time:
+ type: string
+ format: date-time
+ interval:
+ $ref: '#/components/schemas/JobExecutionTypeIntervalChoices'
+ crontab:
+ type: string
+ title: Custom cronjob
+ description: Cronjob syntax string for custom scheduling
+ maxLength: 255
+ required:
+ - display
+ - id
+ - interval
+ - url
+ NestedScheduledJobRequest:
+ 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.
+ - ensures that `id` field is always present on the serializer as well
+ - ensures that `created` and `last_updated` fields are always present if applicable to this model and serializer.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 255
+ start_time:
+ type: string
+ format: date-time
+ interval:
+ $ref: '#/components/schemas/JobExecutionTypeIntervalChoices'
+ crontab:
+ type: string
+ title: Custom cronjob
+ description: Cronjob syntax string for custom scheduling
+ maxLength: 255
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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_]+$
+ required:
+ - display
+ - id
+ - name
+ - url
+ NestedSecretRequest:
+ 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:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ required:
+ - id
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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_]+$
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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'
+ required:
+ - access_type
+ - display
+ - id
+ - secret
+ - secret_type
+ - url
+ NestedSecretsGroupAssociationRequest:
+ 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:
+ access_type:
+ $ref: '#/components/schemas/AccessTypeEnum'
+ secret_type:
+ $ref: '#/components/schemas/SecretTypeEnum'
+ secret:
+ $ref: '#/components/schemas/NestedSecretRequest'
+ required:
+ - id
+ NestedSecretsGroupRequest:
+ 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:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ required:
+ - id
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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_]+$
+ required:
+ - display
+ - id
+ - name
+ - url
+ NestedSiteRequest:
+ 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:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ required:
+ - id
+ NestedSoftwareLCM:
+ type: object
+ description: Nested/brief serializer for SoftwareLCM.
+ properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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
+ required:
+ - device_platform
+ - display
+ - id
+ - url
+ - version
+ NestedSoftwareLCMRequest:
+ type: object
+ description: Nested/brief serializer for SoftwareLCM.
+ properties:
+ version:
+ type: string
+ minLength: 1
+ maxLength: 50
+ end_of_support:
+ type: string
+ format: date
+ nullable: true
+ title: End of Software Support
+ required:
+ - id
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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_]+$
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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'
+ required:
+ - _depth
+ - display
+ - id
+ - name
+ - tenant_count
+ - url
+ NestedTenantGroupRequest:
+ 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:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ required:
+ - id
+ NestedTenantRequest:
+ 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:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ required:
+ - id
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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
+ required:
+ - display
+ - id
+ - url
+ - username
+ NestedUserRequest:
+ 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:
+ username:
+ type: string
+ minLength: 1
+ description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_
+ only.
+ pattern: ^[\w.@+-]+$
+ maxLength: 150
+ required:
+ - id
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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
+ required:
+ - display
+ - id
+ - name
+ - url
+ - vlan_count
+ NestedVLANGroupRequest:
+ 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:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ required:
+ - id
+ NestedVLANRequest:
+ 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:
+ vid:
+ type: integer
+ maximum: 4094
+ minimum: 1
+ title: ID
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ required:
+ - id
+ NestedVMInterface:
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ virtual_machine:
+ allOf:
+ - $ref: '#/components/schemas/NestedVirtualMachine'
+ readOnly: true
+ name:
+ type: string
+ maxLength: 64
+ required:
+ - display
+ - id
+ - name
+ - url
+ - virtual_machine
+ NestedVMInterfaceRequest:
+ 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:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ required:
+ - id
+ 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
+ NestedVRFRequest:
+ 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:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ rd:
+ type: string
+ nullable: true
+ title: Route distinguisher
+ description: Unique route distinguisher (as defined in RFC 4364)
+ maxLength: 21
+ required:
+ - id
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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
+ required:
+ - display
+ - id
+ - master
+ - member_count
+ - name
+ - url
+ NestedVirtualChassisRequest:
+ 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:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ master:
+ $ref: '#/components/schemas/NestedDeviceRequest'
+ required:
+ - id
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ maxLength: 64
+ required:
+ - display
+ - id
+ - name
+ - url
+ NestedVirtualMachineRequest:
+ 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:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ required:
+ - id
+ Note:
+ 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.
+ - ensures that `id` field is always present on the serializer as well
+ - ensures that `created` and `last_updated` fields are always present if applicable to this model and serializer.
+ 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
+ user:
+ allOf:
+ - $ref: '#/components/schemas/NestedUser'
+ readOnly: true
+ user_name:
+ type: string
+ readOnly: true
+ assigned_object_type:
+ type: string
+ assigned_object_id:
+ type: string
+ format: uuid
+ assigned_object:
+ type: object
+ additionalProperties: {}
+ nullable: true
+ readOnly: true
+ note:
+ type: string
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ required:
+ - assigned_object
+ - assigned_object_id
+ - assigned_object_type
+ - created
+ - display
+ - id
+ - last_updated
+ - note
+ - url
+ - user
+ - user_name
+ NoteInputRequest:
+ type: object
+ properties:
+ note:
+ type: string
+ minLength: 1
+ required:
+ - note
+ NoteRequest:
+ 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.
+ - ensures that `id` field is always present on the serializer as well
+ - ensures that `created` and `last_updated` fields are always present if applicable to this model and serializer.
+ properties:
+ assigned_object_type:
+ type: string
+ assigned_object_id:
+ type: string
+ format: uuid
+ note:
+ type: string
+ minLength: 1
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ required:
+ - assigned_object_id
+ - assigned_object_type
+ - note
+ 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
+ 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.
+ - ensures that `id` field is always present on the serializer as well
+ - ensures that `created` and `last_updated` fields are always present if applicable to this model and serializer.
+ 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
+ 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
+ - display
+ - 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ id:
+ type: integer
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ maxLength: 150
+ required:
+ - display
+ - id
+ - name
+ - url
+ users:
+ type: array
+ items:
+ type: object
+ properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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
+ 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)
+ 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
+ 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
+ OnboardingTaskRequest:
+ type: object
+ description: Serializer for the OnboardingTask model.
+ properties:
+ site:
+ type: string
+ description: Nautobot site 'slug' value
+ ip_address:
+ type: string
+ minLength: 1
+ description: IP Address to reach device
+ username:
+ type: string
+ writeOnly: true
+ minLength: 1
+ description: Device username
+ password:
+ type: string
+ writeOnly: true
+ minLength: 1
+ description: Device password
+ secret:
+ type: string
+ writeOnly: true
+ minLength: 1
+ 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
+ minLength: 1
+ description: Nautobot device type 'slug' value
+ platform:
+ type: string
+ description: Nautobot Platform 'slug' value
+ required:
+ - ip_address
+ - site
+ OperatorEnum:
+ enum:
+ - union
+ - intersection
+ - difference
+ type: string
+ OuterUnitEnum:
+ type: string
+ enum:
+ - mm
+ - in
+ 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'
+ PaginatedAddressFamilyList:
+ 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/AddressFamily'
+ PaginatedAddressObjectGroupList:
+ 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/AddressObjectGroup'
+ PaginatedAddressObjectList:
+ 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/AddressObject'
+ 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'
+ PaginatedAutonomousSystemList:
+ 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/AutonomousSystem'
+ 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'
+ PaginatedBGPRoutingInstanceList:
+ 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/BGPRoutingInstance'
+ 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'
+ PaginatedCapircaPolicyList:
+ 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/CapircaPolicy'
+ 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'
+ PaginatedCustomFieldSerializerVersion12List:
+ 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/CustomFieldSerializerVersion12'
+ 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'
+ PaginatedDeviceRedundancyGroupList:
+ 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/DeviceRedundancyGroup'
+ 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'
+ PaginatedDynamicGroupMembershipList:
+ 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/DynamicGroupMembership'
+ 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'
+ PaginatedFQDNList:
+ 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/FQDN'
+ 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'
+ PaginatedIPRangeList:
+ 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/IPRange'
+ 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'
+ PaginatedInterfaceSerializerVersion12List:
+ 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/InterfaceSerializerVersion12'
+ 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'
+ PaginatedJobHookList:
+ 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/JobHook'
+ 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'
+ PaginatedLocationList:
+ 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/Location'
+ PaginatedLocationTypeList:
+ 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/LocationType'
+ 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'
+ PaginatedNATPolicyList:
+ 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/NATPolicy'
+ PaginatedNATPolicyRuleList:
+ 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/NATPolicyRule'
+ 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'
+ PaginatedPeerEndpointList:
+ 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/PeerEndpoint'
+ PaginatedPeerGroupList:
+ 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/PeerGroup'
+ PaginatedPeerGroupTemplateList:
+ 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/PeerGroupTemplate'
+ PaginatedPeeringList:
+ 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/Peering'
+ PaginatedPeeringRoleList:
+ 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/PeeringRole'
+ 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'
+ PaginatedPolicyList:
+ 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/Policy'
+ PaginatedPolicyRuleList:
+ 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/PolicyRule'
+ 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'
+ PaginatedServiceObjectGroupList:
+ 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/ServiceObjectGroup'
+ PaginatedServiceObjectList:
+ 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/ServiceObject'
+ 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'
+ PaginatedUserObjectGroupList:
+ 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/UserObjectGroup'
+ PaginatedUserObjectList:
+ 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/UserObject'
+ 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'
+ PaginatedVMInterfaceSerializerVersion12List:
+ 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/VMInterfaceSerializerVersion12'
+ 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'
+ PaginatedZoneList:
+ 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/Zone'
+ PatchedAccessGrantRequest:
+ type: object
+ description: API serializer for interacting with AccessGrant objects.
+ properties:
+ command:
+ type: string
+ minLength: 1
+ description: Enter * to grant access to all commands
+ maxLength: 64
+ subcommand:
+ type: string
+ minLength: 1
+ description: Enter * to grant access to all subcommands of the
+ given command
+ maxLength: 64
+ grant_type:
+ $ref: '#/components/schemas/GrantTypeEnum'
+ name:
+ type: string
+ minLength: 1
+ description: Organization name, channel name, or user name
+ maxLength: 255
+ value:
+ type: string
+ minLength: 1
+ description: Corresponding ID value to grant access to.
Enter *
+ to grant access to all organizations, channels, or users
+ maxLength: 255
+ PatchedBulkWritableAccessGrantRequest:
+ type: object
+ description: API serializer for interacting with AccessGrant objects.
+ properties:
+ id:
+ type: string
+ format: uuid
+ command:
+ type: string
+ minLength: 1
+ description: Enter * to grant access to all commands
+ maxLength: 64
+ subcommand:
+ type: string
+ minLength: 1
+ description: Enter * to grant access to all subcommands of the
+ given command
+ maxLength: 64
+ grant_type:
+ $ref: '#/components/schemas/GrantTypeEnum'
+ name:
+ type: string
+ minLength: 1
+ description: Organization name, channel name, or user name
+ maxLength: 255
+ value:
+ type: string
+ minLength: 1
+ description: Corresponding ID value to grant access to.
Enter *
+ to grant access to all organizations, channels, or users
+ maxLength: 255
+ required:
+ - id
+ PatchedBulkWritableAddressFamilyRequest:
+ type: object
+ description: REST API serializer for AddressFamily records.
+ properties:
+ id:
+ type: string
+ format: uuid
+ afi_safi:
+ $ref: '#/components/schemas/AfiSafiEnum'
+ vrf:
+ allOf:
+ - $ref: '#/components/schemas/NestedVRFRequest'
+ nullable: true
+ export_policy:
+ type: string
+ maxLength: 100
+ import_policy:
+ type: string
+ maxLength: 100
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - id
+ PatchedBulkWritableAddressObjectGroupRequest:
+ type: object
+ description: AddressObjectGroup Serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ address_objects:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ ip_range:
+ $ref: '#/components/schemas/NestedIPRangeRequest'
+ fqdn:
+ $ref: '#/components/schemas/NestedFQDNRequest'
+ ip_address:
+ $ref: '#/components/schemas/NestedIPAddressRequest'
+ prefix:
+ $ref: '#/components/schemas/NestedPrefixRequest'
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name descriptor for an address object type.
+ maxLength: 100
+ required:
+ - name
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name descriptor for a group address objects.
+ maxLength: 100
+ required:
+ - id
+ PatchedBulkWritableAddressObjectRequest:
+ type: object
+ description: AddressObject Serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ ip_range:
+ $ref: '#/components/schemas/NestedIPRangeRequest'
+ fqdn:
+ $ref: '#/components/schemas/NestedFQDNRequest'
+ ip_address:
+ $ref: '#/components/schemas/NestedIPAddressRequest'
+ prefix:
+ $ref: '#/components/schemas/NestedPrefixRequest'
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name descriptor for an address object type.
+ maxLength: 100
+ required:
+ - id
+ PatchedBulkWritableAggregateRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ prefix:
+ type: string
+ minLength: 1
+ rir:
+ $ref: '#/components/schemas/NestedRIRRequest'
+ tenant:
+ allOf:
+ - $ref: '#/components/schemas/NestedTenantRequest'
+ nullable: true
+ date_added:
+ type: string
+ format: date
+ nullable: true
+ description:
+ type: string
+ maxLength: 200
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableAutonomousSystemRequest:
+ type: object
+ description: REST API serializer for AutonomousSystem records.
+ properties:
+ id:
+ type: string
+ format: uuid
+ asn:
+ type: integer
+ maximum: 4294967295
+ minimum: 1
+ format: int64
+ description: 32-bit autonomous system number
+ description:
+ type: string
+ maxLength: 200
+ status:
+ $ref: '#/components/schemas/Status2a0Enum'
+ provider:
+ allOf:
+ - $ref: '#/components/schemas/NestedProviderRequest'
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - id
+ PatchedBulkWritableBGPRoutingInstanceRequest:
+ type: object
+ description: REST API serializer for Peering records.
+ properties:
+ id:
+ type: string
+ format: uuid
+ device:
+ $ref: '#/components/schemas/NestedDeviceRequest'
+ description:
+ type: string
+ maxLength: 200
+ router_id:
+ allOf:
+ - $ref: '#/components/schemas/NestedIPAddressRequest'
+ nullable: true
+ autonomous_system:
+ allOf:
+ - $ref: '#/components/schemas/NestedAutonomousSystemRequest'
+ nullable: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - id
+ PatchedBulkWritableCVELCMRequest:
+ type: object
+ description: REST API serializer for CVELCM records.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 16
+ published_date:
+ type: string
+ format: date
+ link:
+ type: string
+ format: uri
+ minLength: 1
+ maxLength: 200
+ status:
+ $ref: '#/components/schemas/Status4f5Enum'
+ description:
+ type: string
+ nullable: true
+ maxLength: 255
+ severity:
+ $ref: '#/components/schemas/SeverityEnum'
+ 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/TagSerializerFieldRequest'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableCableRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ termination_a_type:
+ type: string
+ termination_a_id:
+ type: string
+ format: uuid
+ termination_b_type:
+ type: string
+ termination_b_id:
+ type: string
+ format: uuid
+ type:
+ oneOf:
+ - $ref: '#/components/schemas/CableTypeChoices'
+ - $ref: '#/components/schemas/BlankEnum'
+ status:
+ $ref: '#/components/schemas/CableStatusChoices'
+ 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:
+ $ref: '#/components/schemas/LengthUnitEnum'
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableCapircaPolicyRequest:
+ type: object
+ description: CapircaPolicy Serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ pol:
+ type: string
+ nullable: true
+ net:
+ type: string
+ nullable: true
+ svc:
+ type: string
+ nullable: true
+ cfg:
+ type: string
+ nullable: true
+ device:
+ type: string
+ format: uuid
+ nullable: true
+ required:
+ - id
+ PatchedBulkWritableCircuitMaintenanceCircuitImpactRequest:
+ type: object
+ description: Serializer for API.
+ properties:
+ id:
+ type: string
+ format: uuid
+ 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:
+ - id
+ PatchedBulkWritableCircuitMaintenanceRequest:
+ type: object
+ description: Serializer for API.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ 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/StatusD95Enum'
+ - $ref: '#/components/schemas/BlankEnum'
+ - $ref: '#/components/schemas/NullEnum'
+ ack:
+ type: boolean
+ nullable: true
+ required:
+ - id
+ PatchedBulkWritableCircuitRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ cid:
+ type: string
+ minLength: 1
+ title: Circuit ID
+ maxLength: 100
+ provider:
+ $ref: '#/components/schemas/NestedProviderRequest'
+ type:
+ $ref: '#/components/schemas/NestedCircuitTypeRequest'
+ status:
+ $ref: '#/components/schemas/CircuitStatusChoices'
+ tenant:
+ allOf:
+ - $ref: '#/components/schemas/NestedTenantRequest'
+ 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
+ comments:
+ type: string
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableCircuitTerminationRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ circuit:
+ $ref: '#/components/schemas/NestedCircuitRequest'
+ term_side:
+ allOf:
+ - $ref: '#/components/schemas/TermSideEnum'
+ title: Termination
+ site:
+ allOf:
+ - $ref: '#/components/schemas/NestedSiteRequest'
+ nullable: true
+ location:
+ allOf:
+ - $ref: '#/components/schemas/NestedLocationRequest'
+ nullable: true
+ provider_network:
+ allOf:
+ - $ref: '#/components/schemas/NestedProviderNetworkRequest'
+ 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
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableCircuitTypeRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableClusterGroupRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableClusterRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ type:
+ $ref: '#/components/schemas/NestedClusterTypeRequest'
+ group:
+ allOf:
+ - $ref: '#/components/schemas/NestedClusterGroupRequest'
+ nullable: true
+ tenant:
+ allOf:
+ - $ref: '#/components/schemas/NestedTenantRequest'
+ nullable: true
+ site:
+ allOf:
+ - $ref: '#/components/schemas/NestedSiteRequest'
+ nullable: true
+ location:
+ allOf:
+ - $ref: '#/components/schemas/NestedLocationRequest'
+ nullable: true
+ comments:
+ type: string
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableClusterTypeRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableCommandTokenRequest:
+ type: object
+ description: API serializer for interacting with CommandToken objects.
+ properties:
+ id:
+ type: string
+ format: uuid
+ comment:
+ type: string
+ description: 'Optional: Enter description of token'
+ maxLength: 255
+ platform:
+ $ref: '#/components/schemas/PlatformEnum'
+ token:
+ type: string
+ minLength: 1
+ description: Token given by chat platform for signing or command validation
+ maxLength: 255
+ required:
+ - id
+ PatchedBulkWritableComplianceFeatureRequest:
+ type: object
+ description: Serializer for ComplianceFeature object.
+ properties:
+ id:
+ type: string
+ format: uuid
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ minLength: 1
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ description:
+ type: string
+ maxLength: 200
+ required:
+ - id
+ PatchedBulkWritableComplianceRuleRequest:
+ type: object
+ description: Serializer for ComplianceRule object.
+ properties:
+ id:
+ type: string
+ format: uuid
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _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:
+ - id
+ PatchedBulkWritableComputedFieldRequest:
+ 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
+ slug:
+ type: string
+ description: Internal field name. Please use underscores rather than dashes
+ in this slug.
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ label:
+ type: string
+ minLength: 1
+ description: Name of the field as displayed to users
+ maxLength: 100
+ description:
+ type: string
+ maxLength: 200
+ content_type:
+ type: string
+ template:
+ type: string
+ minLength: 1
+ 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
+ required:
+ - id
+ PatchedBulkWritableConfigComplianceRequest:
+ type: object
+ description: Serializer for ConfigCompliance object.
+ properties:
+ id:
+ type: string
+ format: uuid
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _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:
+ - id
+ PatchedBulkWritableConfigContextRequest:
+ 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
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ owner_content_type:
+ type: string
+ nullable: true
+ owner_object_id:
+ type: string
+ format: uuid
+ nullable: true
+ weight:
+ type: integer
+ maximum: 32767
+ minimum: 0
+ description:
+ type: string
+ maxLength: 200
+ schema:
+ allOf:
+ - $ref: '#/components/schemas/NestedConfigContextSchemaRequest'
+ nullable: true
+ is_active:
+ type: boolean
+ regions:
+ type: array
+ items:
+ type: object
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ required:
+ - name
+ sites:
+ type: array
+ items:
+ type: object
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ required:
+ - name
+ locations:
+ type: array
+ items:
+ type: object
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ required:
+ - name
+ roles:
+ type: array
+ items:
+ type: object
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ required:
+ - name
+ device_types:
+ type: array
+ items:
+ type: object
+ properties:
+ model:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ required:
+ - model
+ - slug
+ platforms:
+ type: array
+ items:
+ type: object
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ required:
+ - name
+ cluster_groups:
+ type: array
+ items:
+ type: object
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ required:
+ - name
+ clusters:
+ type: array
+ items:
+ type: object
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ required:
+ - name
+ tenant_groups:
+ type: array
+ items:
+ type: object
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ required:
+ - name
+ tenants:
+ type: array
+ items:
+ type: object
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ required:
+ - name
+ tags:
+ type: array
+ items:
+ type: string
+ data:
+ type: object
+ additionalProperties: {}
+ required:
+ - id
+ PatchedBulkWritableConfigContextSchemaRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ 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
+ description:
+ type: string
+ maxLength: 200
+ data_schema:
+ type: object
+ additionalProperties: {}
+ description: A JSON Schema document which is used to validate a config context
+ object.
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableConfigRemoveRequest:
+ type: object
+ description: Serializer for ConfigRemove object.
+ properties:
+ id:
+ type: string
+ format: uuid
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 255
+ description:
+ type: string
+ maxLength: 200
+ regex:
+ type: string
+ minLength: 1
+ title: Regex Pattern
+ description: Regex pattern used to remove a line from the backup configuration.
+ maxLength: 200
+ platform:
+ type: string
+ format: uuid
+ required:
+ - id
+ PatchedBulkWritableConfigReplaceRequest:
+ type: object
+ description: Serializer for ConfigReplace object.
+ properties:
+ id:
+ type: string
+ format: uuid
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 255
+ description:
+ type: string
+ maxLength: 200
+ regex:
+ type: string
+ minLength: 1
+ title: Regex Pattern to Substitute
+ description: Regex pattern that will be found and replaced with 'replaced
+ text'.
+ maxLength: 200
+ replace:
+ type: string
+ minLength: 1
+ title: Replaced Text
+ description: Text that will be inserted in place of Regex pattern match.
+ maxLength: 200
+ platform:
+ type: string
+ format: uuid
+ required:
+ - id
+ PatchedBulkWritableConsolePortRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ device:
+ $ref: '#/components/schemas/NestedDeviceRequest'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ label:
+ type: string
+ description: Physical label
+ maxLength: 64
+ type:
+ $ref: '#/components/schemas/ConsolePortTypeChoices'
+ description:
+ type: string
+ maxLength: 200
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableConsolePortTemplateRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ device_type:
+ $ref: '#/components/schemas/NestedDeviceTypeRequest'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ label:
+ type: string
+ description: Physical label
+ maxLength: 64
+ type:
+ $ref: '#/components/schemas/ConsolePortTypeChoices'
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableConsoleServerPortRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ device:
+ $ref: '#/components/schemas/NestedDeviceRequest'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ label:
+ type: string
+ description: Physical label
+ maxLength: 64
+ type:
+ $ref: '#/components/schemas/ConsolePortTypeChoices'
+ description:
+ type: string
+ maxLength: 200
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableConsoleServerPortTemplateRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ device_type:
+ $ref: '#/components/schemas/NestedDeviceTypeRequest'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ label:
+ type: string
+ description: Physical label
+ maxLength: 64
+ type:
+ $ref: '#/components/schemas/ConsolePortTypeChoices'
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableContactLCMRequest:
+ type: object
+ description: API serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ nullable: true
+ minLength: 1
+ 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/NestedContractLCMRequest'
+ description: Associated Contract
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableContractLCMRequest:
+ type: object
+ description: API serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ provider:
+ allOf:
+ - $ref: '#/components/schemas/NestedProviderLCMRequest'
+ description: Vendor
+ name:
+ type: string
+ minLength: 1
+ 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
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableCustomFieldChoiceRequest:
+ 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
+ field:
+ $ref: '#/components/schemas/NestedCustomFieldRequest'
+ value:
+ type: string
+ minLength: 1
+ maxLength: 100
+ weight:
+ type: integer
+ maximum: 32767
+ minimum: 0
+ description: Higher weights appear later in the list
+ required:
+ - id
+ PatchedBulkWritableCustomLinkRequest:
+ 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
+ target_url:
+ type: string
+ minLength: 1
+ title: URL
+ description: Jinja2 template code for link URL. Reference the object as
+ {{ obj }} such as {{ obj.platform.slug }}.
+ maxLength: 500
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ content_type:
+ type: string
+ text:
+ type: string
+ minLength: 1
+ description: Jinja2 template code for link text. Reference the object as
+ {{ obj }} such as {{ obj.platform.slug }}. 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
+ required:
+ - id
+ PatchedBulkWritableDeviceBayRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ device:
+ $ref: '#/components/schemas/NestedDeviceRequest'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ label:
+ type: string
+ description: Physical label
+ maxLength: 64
+ description:
+ type: string
+ maxLength: 200
+ installed_device:
+ allOf:
+ - $ref: '#/components/schemas/NestedDeviceRequest'
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableDeviceBayTemplateRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ device_type:
+ $ref: '#/components/schemas/NestedDeviceTypeRequest'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ label:
+ type: string
+ description: Physical label
+ maxLength: 64
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableDeviceRedundancyGroupRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ description:
+ type: string
+ maxLength: 200
+ failover_strategy:
+ $ref: '#/components/schemas/FailoverStrategyEnum'
+ secrets_group:
+ type: string
+ format: uuid
+ nullable: true
+ comments:
+ type: string
+ status:
+ $ref: '#/components/schemas/LocationStatusChoices'
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableDeviceRoleRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ color:
+ type: string
+ minLength: 1
+ 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
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableDeviceTypeRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ manufacturer:
+ $ref: '#/components/schemas/NestedManufacturerRequest'
+ model:
+ type: string
+ minLength: 1
+ 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:
+ $ref: '#/components/schemas/SubdeviceRoleEnum'
+ front_image:
+ type: string
+ format: binary
+ rear_image:
+ type: string
+ format: binary
+ comments:
+ type: string
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableDeviceWithConfigContextRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ nullable: true
+ maxLength: 64
+ device_type:
+ $ref: '#/components/schemas/NestedDeviceTypeRequest'
+ device_role:
+ $ref: '#/components/schemas/NestedDeviceRoleRequest'
+ tenant:
+ allOf:
+ - $ref: '#/components/schemas/NestedTenantRequest'
+ nullable: true
+ platform:
+ allOf:
+ - $ref: '#/components/schemas/NestedPlatformRequest'
+ 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/NestedSiteRequest'
+ location:
+ allOf:
+ - $ref: '#/components/schemas/NestedLocationRequest'
+ nullable: true
+ rack:
+ allOf:
+ - $ref: '#/components/schemas/NestedRackRequest'
+ nullable: true
+ position:
+ type: integer
+ maximum: 32767
+ minimum: 1
+ nullable: true
+ title: Position (U)
+ description: The lowest-numbered unit occupied by the device
+ face:
+ $ref: '#/components/schemas/FaceEnum'
+ status:
+ $ref: '#/components/schemas/DeviceStatusChoices'
+ primary_ip4:
+ allOf:
+ - $ref: '#/components/schemas/NestedIPAddressRequest'
+ nullable: true
+ primary_ip6:
+ allOf:
+ - $ref: '#/components/schemas/NestedIPAddressRequest'
+ nullable: true
+ secrets_group:
+ allOf:
+ - $ref: '#/components/schemas/NestedSecretsGroupRequest'
+ nullable: true
+ cluster:
+ allOf:
+ - $ref: '#/components/schemas/NestedClusterRequest'
+ nullable: true
+ virtual_chassis:
+ allOf:
+ - $ref: '#/components/schemas/NestedVirtualChassisRequest'
+ nullable: true
+ vc_position:
+ type: integer
+ maximum: 255
+ minimum: 0
+ nullable: true
+ vc_priority:
+ type: integer
+ maximum: 255
+ minimum: 0
+ nullable: true
+ device_redundancy_group:
+ allOf:
+ - $ref: '#/components/schemas/NestedDeviceRedundancyGroupRequest'
+ nullable: true
+ device_redundancy_group_priority:
+ type: integer
+ maximum: 32767
+ minimum: 1
+ nullable: true
+ description: The priority the device has in the device redundancy group.
+ comments:
+ type: string
+ local_context_schema:
+ allOf:
+ - $ref: '#/components/schemas/NestedConfigContextSchemaRequest'
+ nullable: true
+ local_context_data:
+ type: object
+ additionalProperties: {}
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableDynamicGroupMembershipRequest:
+ 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
+ group:
+ $ref: '#/components/schemas/NestedDynamicGroupRequest'
+ parent_group:
+ $ref: '#/components/schemas/NestedDynamicGroupRequest'
+ operator:
+ $ref: '#/components/schemas/OperatorEnum'
+ weight:
+ type: integer
+ maximum: 32767
+ minimum: 0
+ required:
+ - id
+ PatchedBulkWritableDynamicGroupRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ 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
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableExportTemplateRequest:
+ type: object
+ description: Extend ValidatedModelSerializer with a `relationships` field.
+ properties:
+ id:
+ type: string
+ format: uuid
+ content_type:
+ type: string
+ owner_content_type:
+ type: string
+ nullable: true
+ owner_object_id:
+ type: string
+ format: uuid
+ nullable: true
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ description:
+ type: string
+ maxLength: 200
+ template_code:
+ type: string
+ minLength: 1
+ description: The list of objects being exported is passed as a context variable
+ named queryset.
+ mime_type:
+ type: string
+ description: Defaults to text/plain
+ maxLength: 50
+ file_extension:
+ type: string
+ description: Extension to append to the rendered filename
+ maxLength: 15
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableFQDNRequest:
+ type: object
+ description: FQDN Serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ ip_addresses:
+ type: array
+ items:
+ type: object
+ properties:
+ address:
+ type: string
+ minLength: 1
+ required:
+ - address
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Resolvable fully qualified domain name (e.g. networktocode.com)
+ maxLength: 254
+ required:
+ - id
+ PatchedBulkWritableFrontPortRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ device:
+ $ref: '#/components/schemas/NestedDeviceRequest'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ label:
+ type: string
+ description: Physical label
+ maxLength: 64
+ type:
+ $ref: '#/components/schemas/PortTypeChoices'
+ rear_port:
+ $ref: '#/components/schemas/FrontPortRearPortRequest'
+ rear_port_position:
+ type: integer
+ maximum: 1024
+ minimum: 1
+ default: 1
+ description:
+ type: string
+ maxLength: 200
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableFrontPortTemplateRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ device_type:
+ $ref: '#/components/schemas/NestedDeviceTypeRequest'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ label:
+ type: string
+ description: Physical label
+ maxLength: 64
+ type:
+ $ref: '#/components/schemas/PortTypeChoices'
+ rear_port:
+ $ref: '#/components/schemas/NestedRearPortTemplateRequest'
+ rear_port_position:
+ type: integer
+ maximum: 1024
+ minimum: 1
+ default: 1
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableGitRepositoryRequest:
+ type: object
+ description: Git repositories defined as a data source.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ remote_url:
+ type: string
+ format: uri
+ minLength: 1
+ description: Only HTTP and HTTPS URLs are presently supported
+ maxLength: 255
+ branch:
+ type: string
+ minLength: 1
+ maxLength: 64
+ token:
+ type: string
+ writeOnly: true
+ minLength: 1
+ username:
+ type: string
+ maxLength: 64
+ secrets_group:
+ allOf:
+ - $ref: '#/components/schemas/NestedSecretsGroupRequest'
+ 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'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableGoldenConfigRequest:
+ type: object
+ description: Serializer for GoldenConfig object.
+ properties:
+ id:
+ type: string
+ format: uuid
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _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:
+ - id
+ PatchedBulkWritableGoldenConfigSettingRequest:
+ type: object
+ description: Serializer for GoldenConfigSetting object.
+ properties:
+ id:
+ type: string
+ format: uuid
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ scope:
+ type: object
+ additionalProperties: {}
+ dynamic_group:
+ $ref: '#/components/schemas/NestedDynamicGroupRequest'
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ minLength: 1
+ 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.
+ 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:
+ - id
+ PatchedBulkWritableGraphQLQueryRequest:
+ 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
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ query:
+ type: string
+ minLength: 1
+ variables:
+ type: object
+ additionalProperties: {}
+ nullable: true
+ default: {}
+ required:
+ - id
+ PatchedBulkWritableGroupRequest:
+ 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
+ name:
+ type: string
+ minLength: 1
+ maxLength: 150
+ required:
+ - id
+ PatchedBulkWritableHardwareLCMRequest:
+ type: object
+ description: API serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ device_type:
+ allOf:
+ - $ref: '#/components/schemas/NestedDeviceTypeRequest'
+ 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/TagSerializerFieldRequest'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableIPAddressRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ address:
+ type: string
+ minLength: 1
+ vrf:
+ allOf:
+ - $ref: '#/components/schemas/NestedVRFRequest'
+ nullable: true
+ tenant:
+ allOf:
+ - $ref: '#/components/schemas/NestedTenantRequest'
+ nullable: true
+ status:
+ $ref: '#/components/schemas/IPAddressStatusChoices'
+ role:
+ $ref: '#/components/schemas/RoleEnum'
+ assigned_object_type:
+ type: string
+ nullable: true
+ assigned_object_id:
+ type: string
+ format: uuid
+ nullable: true
+ nat_inside:
+ allOf:
+ - $ref: '#/components/schemas/NestedIPAddressRequest'
+ nullable: 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/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableIPRangeRequest:
+ type: object
+ description: IPRange Serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ start_address:
+ type: string
+ minLength: 1
+ end_address:
+ type: string
+ minLength: 1
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ vrf:
+ type: string
+ format: uuid
+ nullable: true
+ required:
+ - id
+ PatchedBulkWritableImageAttachmentRequest:
+ 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
+ content_type:
+ type: string
+ object_id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ maxLength: 50
+ image:
+ type: string
+ format: binary
+ image_height:
+ type: integer
+ maximum: 32767
+ minimum: 0
+ image_width:
+ type: integer
+ maximum: 32767
+ minimum: 0
+ required:
+ - id
+ PatchedBulkWritableInterfaceRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ device:
+ $ref: '#/components/schemas/NestedDeviceRequest'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ label:
+ type: string
+ description: Physical label
+ maxLength: 64
+ status:
+ $ref: '#/components/schemas/InterfaceStatusChoices'
+ type:
+ $ref: '#/components/schemas/InterfaceTypeChoices'
+ enabled:
+ type: boolean
+ parent_interface:
+ allOf:
+ - $ref: '#/components/schemas/NestedInterfaceRequest'
+ nullable: true
+ bridge:
+ allOf:
+ - $ref: '#/components/schemas/NestedInterfaceRequest'
+ nullable: true
+ lag:
+ allOf:
+ - $ref: '#/components/schemas/NestedInterfaceRequest'
+ 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:
+ $ref: '#/components/schemas/ModeEnum'
+ untagged_vlan:
+ allOf:
+ - $ref: '#/components/schemas/NestedVLANRequest'
+ nullable: true
+ tagged_vlans:
+ type: array
+ items:
+ type: object
+ properties:
+ vid:
+ type: integer
+ maximum: 4094
+ minimum: 1
+ title: ID
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ required:
+ - name
+ - vid
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableInterfaceTemplateRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ device_type:
+ $ref: '#/components/schemas/NestedDeviceTypeRequest'
+ name:
+ type: string
+ minLength: 1
+ 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: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableInventoryItemRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ device:
+ $ref: '#/components/schemas/NestedDeviceRequest'
+ parent:
+ type: string
+ format: uuid
+ nullable: true
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ label:
+ type: string
+ description: Physical label
+ maxLength: 64
+ manufacturer:
+ allOf:
+ - $ref: '#/components/schemas/NestedManufacturerRequest'
+ 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/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableJobHookRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ content_types:
+ type: array
+ items:
+ type: string
+ job:
+ type: string
+ format: uuid
+ description: The job that this job hook will initiate
+ enabled:
+ type: boolean
+ type_create:
+ type: boolean
+ description: Call this job hook when a matching object is created.
+ type_update:
+ type: boolean
+ description: Call this job hook when a matching object is updated.
+ type_delete:
+ type: boolean
+ description: Call this job hook when a matching object is deleted.
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableJobRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ grouping:
+ type: string
+ minLength: 1
+ 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
+ minLength: 1
+ 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
+ enabled:
+ type: boolean
+ description: Whether this job can be executed by users
+ has_sensitive_variables:
+ type: boolean
+ description: Whether this job contains sensitive variables
+ has_sensitive_variables_override:
+ type: boolean
+ description: If set, the configured value will remain even if the underlying
+ Job source code changes
+ 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 SoftTimeLimitExceeded
+ exception.
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.
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
+ task_queues:
+ type: object
+ additionalProperties: {}
+ description: Comma separated list of task queues that this job can run on.
+ A blank list will use the default queue
+ task_queues_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/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableLocationRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ status:
+ $ref: '#/components/schemas/LocationStatusChoices'
+ location_type:
+ $ref: '#/components/schemas/NestedLocationTypeRequest'
+ parent:
+ allOf:
+ - $ref: '#/components/schemas/NestedLocationRequest'
+ nullable: true
+ site:
+ allOf:
+ - $ref: '#/components/schemas/NestedSiteRequest'
+ nullable: true
+ tenant:
+ allOf:
+ - $ref: '#/components/schemas/NestedTenantRequest'
+ nullable: true
+ description:
+ type: string
+ maxLength: 200
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableLocationTypeRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ parent:
+ allOf:
+ - $ref: '#/components/schemas/NestedLocationTypeRequest'
+ nullable: true
+ nestable:
+ type: boolean
+ description: Allow Locations of this type to be parents/children of other
+ Locations of this same type
+ content_types:
+ type: array
+ items:
+ type: string
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableManufacturerRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableMinMaxValidationRuleRequest:
+ type: object
+ description: Serializer for `MinMaxValidationRule` objects.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ minLength: 1
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ content_type:
+ type: string
+ field:
+ type: string
+ minLength: 1
+ 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
+ required:
+ - id
+ PatchedBulkWritableNATPolicyRequest:
+ type: object
+ description: NATPolicy Serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ assigned_devices:
+ type: array
+ items:
+ $ref: '#/components/schemas/NATPolicyDeviceM2MNestedRequest'
+ assigned_dynamic_groups:
+ type: array
+ items:
+ $ref: '#/components/schemas/NATPolicyDynamicGroupM2MNestedRequest'
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ tenant:
+ type: string
+ format: uuid
+ nullable: true
+ required:
+ - id
+ PatchedBulkWritableNATPolicyRuleRequest:
+ type: object
+ description: PolicyRule Serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ source_zone:
+ $ref: '#/components/schemas/ZoneRequest'
+ destination_zone:
+ $ref: '#/components/schemas/ZoneRequest'
+ original_source_addresses:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ ip_range:
+ $ref: '#/components/schemas/NestedIPRangeRequest'
+ fqdn:
+ $ref: '#/components/schemas/NestedFQDNRequest'
+ ip_address:
+ $ref: '#/components/schemas/NestedIPAddressRequest'
+ prefix:
+ $ref: '#/components/schemas/NestedPrefixRequest'
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name descriptor for an address object type.
+ maxLength: 100
+ required:
+ - name
+ original_source_address_groups:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ address_objects:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ ip_range:
+ $ref: '#/components/schemas/NestedIPRangeRequest'
+ fqdn:
+ $ref: '#/components/schemas/NestedFQDNRequest'
+ ip_address:
+ $ref: '#/components/schemas/NestedIPAddressRequest'
+ prefix:
+ $ref: '#/components/schemas/NestedPrefixRequest'
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name descriptor for an address object type.
+ maxLength: 100
+ required:
+ - name
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name descriptor for a group address objects.
+ maxLength: 100
+ required:
+ - name
+ original_source_services:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name of the service (e.g. HTTP)
+ maxLength: 100
+ port:
+ type: string
+ nullable: true
+ description: The port or port range to tie to a service (e.g. HTTP
+ would be port 80)
+ maxLength: 20
+ ip_protocol:
+ enum:
+ - ICMP
+ - IGMP
+ - GGP
+ - TCP
+ - CBT
+ - EGP
+ - IGP
+ - BBN-RCC-MON
+ - NVP-II
+ - PUP
+ - EMCON
+ - XNET
+ - CHAOS
+ - UDP
+ - MUX
+ - DCN-MEAS
+ - HMP
+ - PRM
+ - XNS-IDP
+ - TRUNK-1
+ - TRUNK-2
+ - LEAF-1
+ - LEAF-2
+ - RDP
+ - IRTP
+ - ISO-TP4
+ - NETBLT
+ - MFE-NSP
+ - MERIT-INP
+ - DCCP
+ - 3PC
+ - IDPR
+ - XTP
+ - DDP
+ - IDPR-CMTP
+ - TP++
+ - IL
+ - SDRP
+ - IDRP
+ - RSVP
+ - GRE
+ - DSR
+ - BNA
+ - ESP
+ - AH
+ - I-NLSP
+ - NARP
+ - MOBILE
+ - TLSP
+ - SKIP
+ - CFTP
+ - SAT-EXPAK
+ - KRYPTOLAN
+ - RVD
+ - IPPC
+ - SAT-MON
+ - VISA
+ - IPCV
+ - CPNX
+ - CPHB
+ - WSN
+ - PVP
+ - BR-SAT-MON
+ - SUN-ND
+ - WB-MON
+ - WB-EXPAK
+ - ISO-IP
+ - VMTP
+ - SECURE-VMTP
+ - VINES
+ - TTP
+ - NSFNET-IGP
+ - DGP
+ - TCF
+ - EIGRP
+ - OSPFIGP
+ - Sprite-RPC
+ - LARP
+ - MTP
+ - AX.25
+ - IPIP
+ - SCC-SP
+ - ETHERIP
+ - ENCAP
+ - GMTP
+ - IFMP
+ - PNNI
+ - PIM
+ - ARIS
+ - SCPS
+ - QNX
+ - A/N
+ - IPComp
+ - SNP
+ - Compaq-Peer
+ - IPX-in-IP
+ - PGM
+ - L2TP
+ - DDX
+ - IATP
+ - STP
+ - SRP
+ - UTI
+ - SMP
+ - SM
+ - PTP
+ - FIRE
+ - CRTP
+ - CRUDP
+ - SSCOPMCE
+ - IPLT
+ - SPS
+ - PIPE
+ - SCTP
+ - FC
+ - RSVP-E2E-IGNORE
+ - UDPLite
+ - manet
+ - HIP
+ - WESP
+ - ROHC
+ - Ethernet
+ type: string
+ description: IANA IP Protocol (e.g. TCP UDP ICMP)
+ required:
+ - ip_protocol
+ - name
+ original_source_service_groups:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ service_objects:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name of the service (e.g. HTTP)
+ maxLength: 100
+ port:
+ type: string
+ nullable: true
+ description: The port or port range to tie to a service (e.g.
+ HTTP would be port 80)
+ maxLength: 20
+ ip_protocol:
+ enum:
+ - ICMP
+ - IGMP
+ - GGP
+ - TCP
+ - CBT
+ - EGP
+ - IGP
+ - BBN-RCC-MON
+ - NVP-II
+ - PUP
+ - EMCON
+ - XNET
+ - CHAOS
+ - UDP
+ - MUX
+ - DCN-MEAS
+ - HMP
+ - PRM
+ - XNS-IDP
+ - TRUNK-1
+ - TRUNK-2
+ - LEAF-1
+ - LEAF-2
+ - RDP
+ - IRTP
+ - ISO-TP4
+ - NETBLT
+ - MFE-NSP
+ - MERIT-INP
+ - DCCP
+ - 3PC
+ - IDPR
+ - XTP
+ - DDP
+ - IDPR-CMTP
+ - TP++
+ - IL
+ - SDRP
+ - IDRP
+ - RSVP
+ - GRE
+ - DSR
+ - BNA
+ - ESP
+ - AH
+ - I-NLSP
+ - NARP
+ - MOBILE
+ - TLSP
+ - SKIP
+ - CFTP
+ - SAT-EXPAK
+ - KRYPTOLAN
+ - RVD
+ - IPPC
+ - SAT-MON
+ - VISA
+ - IPCV
+ - CPNX
+ - CPHB
+ - WSN
+ - PVP
+ - BR-SAT-MON
+ - SUN-ND
+ - WB-MON
+ - WB-EXPAK
+ - ISO-IP
+ - VMTP
+ - SECURE-VMTP
+ - VINES
+ - TTP
+ - NSFNET-IGP
+ - DGP
+ - TCF
+ - EIGRP
+ - OSPFIGP
+ - Sprite-RPC
+ - LARP
+ - MTP
+ - AX.25
+ - IPIP
+ - SCC-SP
+ - ETHERIP
+ - ENCAP
+ - GMTP
+ - IFMP
+ - PNNI
+ - PIM
+ - ARIS
+ - SCPS
+ - QNX
+ - A/N
+ - IPComp
+ - SNP
+ - Compaq-Peer
+ - IPX-in-IP
+ - PGM
+ - L2TP
+ - DDX
+ - IATP
+ - STP
+ - SRP
+ - UTI
+ - SMP
+ - SM
+ - PTP
+ - FIRE
+ - CRTP
+ - CRUDP
+ - SSCOPMCE
+ - IPLT
+ - SPS
+ - PIPE
+ - SCTP
+ - FC
+ - RSVP-E2E-IGNORE
+ - UDPLite
+ - manet
+ - HIP
+ - WESP
+ - ROHC
+ - Ethernet
+ type: string
+ description: IANA IP Protocol (e.g. TCP UDP ICMP)
+ required:
+ - ip_protocol
+ - name
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ required:
+ - name
+ translated_source_addresses:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ ip_range:
+ $ref: '#/components/schemas/NestedIPRangeRequest'
+ fqdn:
+ $ref: '#/components/schemas/NestedFQDNRequest'
+ ip_address:
+ $ref: '#/components/schemas/NestedIPAddressRequest'
+ prefix:
+ $ref: '#/components/schemas/NestedPrefixRequest'
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name descriptor for an address object type.
+ maxLength: 100
+ required:
+ - name
+ translated_source_address_groups:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ address_objects:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ ip_range:
+ $ref: '#/components/schemas/NestedIPRangeRequest'
+ fqdn:
+ $ref: '#/components/schemas/NestedFQDNRequest'
+ ip_address:
+ $ref: '#/components/schemas/NestedIPAddressRequest'
+ prefix:
+ $ref: '#/components/schemas/NestedPrefixRequest'
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name descriptor for an address object type.
+ maxLength: 100
+ required:
+ - name
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name descriptor for a group address objects.
+ maxLength: 100
+ required:
+ - name
+ translated_source_services:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name of the service (e.g. HTTP)
+ maxLength: 100
+ port:
+ type: string
+ nullable: true
+ description: The port or port range to tie to a service (e.g. HTTP
+ would be port 80)
+ maxLength: 20
+ ip_protocol:
+ enum:
+ - ICMP
+ - IGMP
+ - GGP
+ - TCP
+ - CBT
+ - EGP
+ - IGP
+ - BBN-RCC-MON
+ - NVP-II
+ - PUP
+ - EMCON
+ - XNET
+ - CHAOS
+ - UDP
+ - MUX
+ - DCN-MEAS
+ - HMP
+ - PRM
+ - XNS-IDP
+ - TRUNK-1
+ - TRUNK-2
+ - LEAF-1
+ - LEAF-2
+ - RDP
+ - IRTP
+ - ISO-TP4
+ - NETBLT
+ - MFE-NSP
+ - MERIT-INP
+ - DCCP
+ - 3PC
+ - IDPR
+ - XTP
+ - DDP
+ - IDPR-CMTP
+ - TP++
+ - IL
+ - SDRP
+ - IDRP
+ - RSVP
+ - GRE
+ - DSR
+ - BNA
+ - ESP
+ - AH
+ - I-NLSP
+ - NARP
+ - MOBILE
+ - TLSP
+ - SKIP
+ - CFTP
+ - SAT-EXPAK
+ - KRYPTOLAN
+ - RVD
+ - IPPC
+ - SAT-MON
+ - VISA
+ - IPCV
+ - CPNX
+ - CPHB
+ - WSN
+ - PVP
+ - BR-SAT-MON
+ - SUN-ND
+ - WB-MON
+ - WB-EXPAK
+ - ISO-IP
+ - VMTP
+ - SECURE-VMTP
+ - VINES
+ - TTP
+ - NSFNET-IGP
+ - DGP
+ - TCF
+ - EIGRP
+ - OSPFIGP
+ - Sprite-RPC
+ - LARP
+ - MTP
+ - AX.25
+ - IPIP
+ - SCC-SP
+ - ETHERIP
+ - ENCAP
+ - GMTP
+ - IFMP
+ - PNNI
+ - PIM
+ - ARIS
+ - SCPS
+ - QNX
+ - A/N
+ - IPComp
+ - SNP
+ - Compaq-Peer
+ - IPX-in-IP
+ - PGM
+ - L2TP
+ - DDX
+ - IATP
+ - STP
+ - SRP
+ - UTI
+ - SMP
+ - SM
+ - PTP
+ - FIRE
+ - CRTP
+ - CRUDP
+ - SSCOPMCE
+ - IPLT
+ - SPS
+ - PIPE
+ - SCTP
+ - FC
+ - RSVP-E2E-IGNORE
+ - UDPLite
+ - manet
+ - HIP
+ - WESP
+ - ROHC
+ - Ethernet
+ type: string
+ description: IANA IP Protocol (e.g. TCP UDP ICMP)
+ required:
+ - ip_protocol
+ - name
+ translated_source_service_groups:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ service_objects:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name of the service (e.g. HTTP)
+ maxLength: 100
+ port:
+ type: string
+ nullable: true
+ description: The port or port range to tie to a service (e.g.
+ HTTP would be port 80)
+ maxLength: 20
+ ip_protocol:
+ enum:
+ - ICMP
+ - IGMP
+ - GGP
+ - TCP
+ - CBT
+ - EGP
+ - IGP
+ - BBN-RCC-MON
+ - NVP-II
+ - PUP
+ - EMCON
+ - XNET
+ - CHAOS
+ - UDP
+ - MUX
+ - DCN-MEAS
+ - HMP
+ - PRM
+ - XNS-IDP
+ - TRUNK-1
+ - TRUNK-2
+ - LEAF-1
+ - LEAF-2
+ - RDP
+ - IRTP
+ - ISO-TP4
+ - NETBLT
+ - MFE-NSP
+ - MERIT-INP
+ - DCCP
+ - 3PC
+ - IDPR
+ - XTP
+ - DDP
+ - IDPR-CMTP
+ - TP++
+ - IL
+ - SDRP
+ - IDRP
+ - RSVP
+ - GRE
+ - DSR
+ - BNA
+ - ESP
+ - AH
+ - I-NLSP
+ - NARP
+ - MOBILE
+ - TLSP
+ - SKIP
+ - CFTP
+ - SAT-EXPAK
+ - KRYPTOLAN
+ - RVD
+ - IPPC
+ - SAT-MON
+ - VISA
+ - IPCV
+ - CPNX
+ - CPHB
+ - WSN
+ - PVP
+ - BR-SAT-MON
+ - SUN-ND
+ - WB-MON
+ - WB-EXPAK
+ - ISO-IP
+ - VMTP
+ - SECURE-VMTP
+ - VINES
+ - TTP
+ - NSFNET-IGP
+ - DGP
+ - TCF
+ - EIGRP
+ - OSPFIGP
+ - Sprite-RPC
+ - LARP
+ - MTP
+ - AX.25
+ - IPIP
+ - SCC-SP
+ - ETHERIP
+ - ENCAP
+ - GMTP
+ - IFMP
+ - PNNI
+ - PIM
+ - ARIS
+ - SCPS
+ - QNX
+ - A/N
+ - IPComp
+ - SNP
+ - Compaq-Peer
+ - IPX-in-IP
+ - PGM
+ - L2TP
+ - DDX
+ - IATP
+ - STP
+ - SRP
+ - UTI
+ - SMP
+ - SM
+ - PTP
+ - FIRE
+ - CRTP
+ - CRUDP
+ - SSCOPMCE
+ - IPLT
+ - SPS
+ - PIPE
+ - SCTP
+ - FC
+ - RSVP-E2E-IGNORE
+ - UDPLite
+ - manet
+ - HIP
+ - WESP
+ - ROHC
+ - Ethernet
+ type: string
+ description: IANA IP Protocol (e.g. TCP UDP ICMP)
+ required:
+ - ip_protocol
+ - name
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ required:
+ - name
+ original_destination_addresses:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ ip_range:
+ $ref: '#/components/schemas/NestedIPRangeRequest'
+ fqdn:
+ $ref: '#/components/schemas/NestedFQDNRequest'
+ ip_address:
+ $ref: '#/components/schemas/NestedIPAddressRequest'
+ prefix:
+ $ref: '#/components/schemas/NestedPrefixRequest'
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name descriptor for an address object type.
+ maxLength: 100
+ required:
+ - name
+ original_destination_address_groups:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ address_objects:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ ip_range:
+ $ref: '#/components/schemas/NestedIPRangeRequest'
+ fqdn:
+ $ref: '#/components/schemas/NestedFQDNRequest'
+ ip_address:
+ $ref: '#/components/schemas/NestedIPAddressRequest'
+ prefix:
+ $ref: '#/components/schemas/NestedPrefixRequest'
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name descriptor for an address object type.
+ maxLength: 100
+ required:
+ - name
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name descriptor for a group address objects.
+ maxLength: 100
+ required:
+ - name
+ original_destination_services:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name of the service (e.g. HTTP)
+ maxLength: 100
+ port:
+ type: string
+ nullable: true
+ description: The port or port range to tie to a service (e.g. HTTP
+ would be port 80)
+ maxLength: 20
+ ip_protocol:
+ enum:
+ - ICMP
+ - IGMP
+ - GGP
+ - TCP
+ - CBT
+ - EGP
+ - IGP
+ - BBN-RCC-MON
+ - NVP-II
+ - PUP
+ - EMCON
+ - XNET
+ - CHAOS
+ - UDP
+ - MUX
+ - DCN-MEAS
+ - HMP
+ - PRM
+ - XNS-IDP
+ - TRUNK-1
+ - TRUNK-2
+ - LEAF-1
+ - LEAF-2
+ - RDP
+ - IRTP
+ - ISO-TP4
+ - NETBLT
+ - MFE-NSP
+ - MERIT-INP
+ - DCCP
+ - 3PC
+ - IDPR
+ - XTP
+ - DDP
+ - IDPR-CMTP
+ - TP++
+ - IL
+ - SDRP
+ - IDRP
+ - RSVP
+ - GRE
+ - DSR
+ - BNA
+ - ESP
+ - AH
+ - I-NLSP
+ - NARP
+ - MOBILE
+ - TLSP
+ - SKIP
+ - CFTP
+ - SAT-EXPAK
+ - KRYPTOLAN
+ - RVD
+ - IPPC
+ - SAT-MON
+ - VISA
+ - IPCV
+ - CPNX
+ - CPHB
+ - WSN
+ - PVP
+ - BR-SAT-MON
+ - SUN-ND
+ - WB-MON
+ - WB-EXPAK
+ - ISO-IP
+ - VMTP
+ - SECURE-VMTP
+ - VINES
+ - TTP
+ - NSFNET-IGP
+ - DGP
+ - TCF
+ - EIGRP
+ - OSPFIGP
+ - Sprite-RPC
+ - LARP
+ - MTP
+ - AX.25
+ - IPIP
+ - SCC-SP
+ - ETHERIP
+ - ENCAP
+ - GMTP
+ - IFMP
+ - PNNI
+ - PIM
+ - ARIS
+ - SCPS
+ - QNX
+ - A/N
+ - IPComp
+ - SNP
+ - Compaq-Peer
+ - IPX-in-IP
+ - PGM
+ - L2TP
+ - DDX
+ - IATP
+ - STP
+ - SRP
+ - UTI
+ - SMP
+ - SM
+ - PTP
+ - FIRE
+ - CRTP
+ - CRUDP
+ - SSCOPMCE
+ - IPLT
+ - SPS
+ - PIPE
+ - SCTP
+ - FC
+ - RSVP-E2E-IGNORE
+ - UDPLite
+ - manet
+ - HIP
+ - WESP
+ - ROHC
+ - Ethernet
+ type: string
+ description: IANA IP Protocol (e.g. TCP UDP ICMP)
+ required:
+ - ip_protocol
+ - name
+ original_destination_service_groups:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ service_objects:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name of the service (e.g. HTTP)
+ maxLength: 100
+ port:
+ type: string
+ nullable: true
+ description: The port or port range to tie to a service (e.g.
+ HTTP would be port 80)
+ maxLength: 20
+ ip_protocol:
+ enum:
+ - ICMP
+ - IGMP
+ - GGP
+ - TCP
+ - CBT
+ - EGP
+ - IGP
+ - BBN-RCC-MON
+ - NVP-II
+ - PUP
+ - EMCON
+ - XNET
+ - CHAOS
+ - UDP
+ - MUX
+ - DCN-MEAS
+ - HMP
+ - PRM
+ - XNS-IDP
+ - TRUNK-1
+ - TRUNK-2
+ - LEAF-1
+ - LEAF-2
+ - RDP
+ - IRTP
+ - ISO-TP4
+ - NETBLT
+ - MFE-NSP
+ - MERIT-INP
+ - DCCP
+ - 3PC
+ - IDPR
+ - XTP
+ - DDP
+ - IDPR-CMTP
+ - TP++
+ - IL
+ - SDRP
+ - IDRP
+ - RSVP
+ - GRE
+ - DSR
+ - BNA
+ - ESP
+ - AH
+ - I-NLSP
+ - NARP
+ - MOBILE
+ - TLSP
+ - SKIP
+ - CFTP
+ - SAT-EXPAK
+ - KRYPTOLAN
+ - RVD
+ - IPPC
+ - SAT-MON
+ - VISA
+ - IPCV
+ - CPNX
+ - CPHB
+ - WSN
+ - PVP
+ - BR-SAT-MON
+ - SUN-ND
+ - WB-MON
+ - WB-EXPAK
+ - ISO-IP
+ - VMTP
+ - SECURE-VMTP
+ - VINES
+ - TTP
+ - NSFNET-IGP
+ - DGP
+ - TCF
+ - EIGRP
+ - OSPFIGP
+ - Sprite-RPC
+ - LARP
+ - MTP
+ - AX.25
+ - IPIP
+ - SCC-SP
+ - ETHERIP
+ - ENCAP
+ - GMTP
+ - IFMP
+ - PNNI
+ - PIM
+ - ARIS
+ - SCPS
+ - QNX
+ - A/N
+ - IPComp
+ - SNP
+ - Compaq-Peer
+ - IPX-in-IP
+ - PGM
+ - L2TP
+ - DDX
+ - IATP
+ - STP
+ - SRP
+ - UTI
+ - SMP
+ - SM
+ - PTP
+ - FIRE
+ - CRTP
+ - CRUDP
+ - SSCOPMCE
+ - IPLT
+ - SPS
+ - PIPE
+ - SCTP
+ - FC
+ - RSVP-E2E-IGNORE
+ - UDPLite
+ - manet
+ - HIP
+ - WESP
+ - ROHC
+ - Ethernet
+ type: string
+ description: IANA IP Protocol (e.g. TCP UDP ICMP)
+ required:
+ - ip_protocol
+ - name
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ required:
+ - name
+ translated_destination_addresses:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ ip_range:
+ $ref: '#/components/schemas/NestedIPRangeRequest'
+ fqdn:
+ $ref: '#/components/schemas/NestedFQDNRequest'
+ ip_address:
+ $ref: '#/components/schemas/NestedIPAddressRequest'
+ prefix:
+ $ref: '#/components/schemas/NestedPrefixRequest'
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name descriptor for an address object type.
+ maxLength: 100
+ required:
+ - name
+ translated_destination_address_groups:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ address_objects:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ ip_range:
+ $ref: '#/components/schemas/NestedIPRangeRequest'
+ fqdn:
+ $ref: '#/components/schemas/NestedFQDNRequest'
+ ip_address:
+ $ref: '#/components/schemas/NestedIPAddressRequest'
+ prefix:
+ $ref: '#/components/schemas/NestedPrefixRequest'
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name descriptor for an address object type.
+ maxLength: 100
+ required:
+ - name
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name descriptor for a group address objects.
+ maxLength: 100
+ required:
+ - name
+ translated_destination_services:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name of the service (e.g. HTTP)
+ maxLength: 100
+ port:
+ type: string
+ nullable: true
+ description: The port or port range to tie to a service (e.g. HTTP
+ would be port 80)
+ maxLength: 20
+ ip_protocol:
+ enum:
+ - ICMP
+ - IGMP
+ - GGP
+ - TCP
+ - CBT
+ - EGP
+ - IGP
+ - BBN-RCC-MON
+ - NVP-II
+ - PUP
+ - EMCON
+ - XNET
+ - CHAOS
+ - UDP
+ - MUX
+ - DCN-MEAS
+ - HMP
+ - PRM
+ - XNS-IDP
+ - TRUNK-1
+ - TRUNK-2
+ - LEAF-1
+ - LEAF-2
+ - RDP
+ - IRTP
+ - ISO-TP4
+ - NETBLT
+ - MFE-NSP
+ - MERIT-INP
+ - DCCP
+ - 3PC
+ - IDPR
+ - XTP
+ - DDP
+ - IDPR-CMTP
+ - TP++
+ - IL
+ - SDRP
+ - IDRP
+ - RSVP
+ - GRE
+ - DSR
+ - BNA
+ - ESP
+ - AH
+ - I-NLSP
+ - NARP
+ - MOBILE
+ - TLSP
+ - SKIP
+ - CFTP
+ - SAT-EXPAK
+ - KRYPTOLAN
+ - RVD
+ - IPPC
+ - SAT-MON
+ - VISA
+ - IPCV
+ - CPNX
+ - CPHB
+ - WSN
+ - PVP
+ - BR-SAT-MON
+ - SUN-ND
+ - WB-MON
+ - WB-EXPAK
+ - ISO-IP
+ - VMTP
+ - SECURE-VMTP
+ - VINES
+ - TTP
+ - NSFNET-IGP
+ - DGP
+ - TCF
+ - EIGRP
+ - OSPFIGP
+ - Sprite-RPC
+ - LARP
+ - MTP
+ - AX.25
+ - IPIP
+ - SCC-SP
+ - ETHERIP
+ - ENCAP
+ - GMTP
+ - IFMP
+ - PNNI
+ - PIM
+ - ARIS
+ - SCPS
+ - QNX
+ - A/N
+ - IPComp
+ - SNP
+ - Compaq-Peer
+ - IPX-in-IP
+ - PGM
+ - L2TP
+ - DDX
+ - IATP
+ - STP
+ - SRP
+ - UTI
+ - SMP
+ - SM
+ - PTP
+ - FIRE
+ - CRTP
+ - CRUDP
+ - SSCOPMCE
+ - IPLT
+ - SPS
+ - PIPE
+ - SCTP
+ - FC
+ - RSVP-E2E-IGNORE
+ - UDPLite
+ - manet
+ - HIP
+ - WESP
+ - ROHC
+ - Ethernet
+ type: string
+ description: IANA IP Protocol (e.g. TCP UDP ICMP)
+ required:
+ - ip_protocol
+ - name
+ translated_destination_service_groups:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ service_objects:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name of the service (e.g. HTTP)
+ maxLength: 100
+ port:
+ type: string
+ nullable: true
+ description: The port or port range to tie to a service (e.g.
+ HTTP would be port 80)
+ maxLength: 20
+ ip_protocol:
+ enum:
+ - ICMP
+ - IGMP
+ - GGP
+ - TCP
+ - CBT
+ - EGP
+ - IGP
+ - BBN-RCC-MON
+ - NVP-II
+ - PUP
+ - EMCON
+ - XNET
+ - CHAOS
+ - UDP
+ - MUX
+ - DCN-MEAS
+ - HMP
+ - PRM
+ - XNS-IDP
+ - TRUNK-1
+ - TRUNK-2
+ - LEAF-1
+ - LEAF-2
+ - RDP
+ - IRTP
+ - ISO-TP4
+ - NETBLT
+ - MFE-NSP
+ - MERIT-INP
+ - DCCP
+ - 3PC
+ - IDPR
+ - XTP
+ - DDP
+ - IDPR-CMTP
+ - TP++
+ - IL
+ - SDRP
+ - IDRP
+ - RSVP
+ - GRE
+ - DSR
+ - BNA
+ - ESP
+ - AH
+ - I-NLSP
+ - NARP
+ - MOBILE
+ - TLSP
+ - SKIP
+ - CFTP
+ - SAT-EXPAK
+ - KRYPTOLAN
+ - RVD
+ - IPPC
+ - SAT-MON
+ - VISA
+ - IPCV
+ - CPNX
+ - CPHB
+ - WSN
+ - PVP
+ - BR-SAT-MON
+ - SUN-ND
+ - WB-MON
+ - WB-EXPAK
+ - ISO-IP
+ - VMTP
+ - SECURE-VMTP
+ - VINES
+ - TTP
+ - NSFNET-IGP
+ - DGP
+ - TCF
+ - EIGRP
+ - OSPFIGP
+ - Sprite-RPC
+ - LARP
+ - MTP
+ - AX.25
+ - IPIP
+ - SCC-SP
+ - ETHERIP
+ - ENCAP
+ - GMTP
+ - IFMP
+ - PNNI
+ - PIM
+ - ARIS
+ - SCPS
+ - QNX
+ - A/N
+ - IPComp
+ - SNP
+ - Compaq-Peer
+ - IPX-in-IP
+ - PGM
+ - L2TP
+ - DDX
+ - IATP
+ - STP
+ - SRP
+ - UTI
+ - SMP
+ - SM
+ - PTP
+ - FIRE
+ - CRTP
+ - CRUDP
+ - SSCOPMCE
+ - IPLT
+ - SPS
+ - PIPE
+ - SCTP
+ - FC
+ - RSVP-E2E-IGNORE
+ - UDPLite
+ - manet
+ - HIP
+ - WESP
+ - ROHC
+ - Ethernet
+ type: string
+ description: IANA IP Protocol (e.g. TCP UDP ICMP)
+ required:
+ - ip_protocol
+ - name
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ required:
+ - name
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ remark:
+ type: boolean
+ log:
+ type: boolean
+ request_id:
+ type: string
+ nullable: true
+ maxLength: 100
+ description:
+ type: string
+ nullable: true
+ maxLength: 200
+ index:
+ type: integer
+ maximum: 32767
+ minimum: 0
+ nullable: true
+ required:
+ - id
+ PatchedBulkWritableNoteRequest:
+ 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.
+ - ensures that `id` field is always present on the serializer as well
+ - ensures that `created` and `last_updated` fields are always present if applicable to this model and serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ assigned_object_type:
+ type: string
+ assigned_object_id:
+ type: string
+ format: uuid
+ note:
+ type: string
+ minLength: 1
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ required:
+ - id
+ PatchedBulkWritableObjectPermissionRequest:
+ 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
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ description:
+ type: string
+ maxLength: 200
+ enabled:
+ type: boolean
+ object_types:
+ type: array
+ items:
+ type: string
+ groups:
+ type: array
+ items:
+ type: object
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 150
+ required:
+ - name
+ users:
+ type: array
+ items:
+ type: object
+ properties:
+ username:
+ type: string
+ minLength: 1
+ description: Required. 150 characters or fewer. Letters, digits and
+ @/./+/-/_ only.
+ pattern: ^[\w.@+-]+$
+ maxLength: 150
+ required:
+ - 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)
+ required:
+ - id
+ PatchedBulkWritablePeerEndpointRequest:
+ type: object
+ description: REST API serializer for PeerEndpoint records.
+ properties:
+ id:
+ type: string
+ format: uuid
+ source_ip:
+ allOf:
+ - $ref: '#/components/schemas/NestedIPAddressRequest'
+ nullable: true
+ source_interface:
+ allOf:
+ - $ref: '#/components/schemas/NestedInterfaceRequest'
+ nullable: true
+ autonomous_system:
+ allOf:
+ - $ref: '#/components/schemas/NestedAutonomousSystemRequest'
+ nullable: true
+ peer_group:
+ allOf:
+ - $ref: '#/components/schemas/NestedPeerGroupRequest'
+ nullable: true
+ import_policy:
+ type: string
+ maxLength: 100
+ export_policy:
+ type: string
+ maxLength: 100
+ peering:
+ allOf:
+ - $ref: '#/components/schemas/NestedPeeringRequest'
+ nullable: true
+ secret:
+ allOf:
+ - $ref: '#/components/schemas/NestedSecretRequest'
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ enabled:
+ type: boolean
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - id
+ PatchedBulkWritablePeerGroupRequest:
+ type: object
+ description: REST API serializer for PeerGroup records.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ source_ip:
+ allOf:
+ - $ref: '#/components/schemas/NestedIPAddressRequest'
+ nullable: true
+ source_interface:
+ allOf:
+ - $ref: '#/components/schemas/NestedInterfaceRequest'
+ nullable: true
+ description:
+ type: string
+ maxLength: 200
+ enabled:
+ type: boolean
+ autonomous_system:
+ allOf:
+ - $ref: '#/components/schemas/NestedAutonomousSystemRequest'
+ nullable: true
+ template:
+ allOf:
+ - $ref: '#/components/schemas/NestedPeerGroupTemplateRequest'
+ nullable: true
+ secret:
+ allOf:
+ - $ref: '#/components/schemas/NestedSecretRequest'
+ nullable: true
+ role:
+ type: string
+ format: uuid
+ nullable: true
+ import_policy:
+ type: string
+ maxLength: 100
+ export_policy:
+ type: string
+ maxLength: 100
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - id
+ PatchedBulkWritablePeerGroupTemplateRequest:
+ type: object
+ description: REST API serializer for PeerGroup records.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ role:
+ type: string
+ format: uuid
+ nullable: true
+ description:
+ type: string
+ maxLength: 200
+ enabled:
+ type: boolean
+ autonomous_system:
+ allOf:
+ - $ref: '#/components/schemas/NestedAutonomousSystemRequest'
+ nullable: true
+ import_policy:
+ type: string
+ maxLength: 100
+ export_policy:
+ type: string
+ maxLength: 100
+ secret:
+ allOf:
+ - $ref: '#/components/schemas/NestedSecretRequest'
+ nullable: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - id
+ PatchedBulkWritablePeeringRequest:
+ type: object
+ description: REST API serializer for Peering records.
+ properties:
+ id:
+ type: string
+ format: uuid
+ status:
+ $ref: '#/components/schemas/CircuitStatusChoices'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - id
+ PatchedBulkWritablePeeringRoleRequest:
+ type: object
+ description: REST API serializer for PeeringRole records.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ color:
+ type: string
+ minLength: 1
+ pattern: ^[0-9a-f]{6}$
+ maxLength: 6
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - id
+ PatchedBulkWritablePlatformRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ manufacturer:
+ allOf:
+ - $ref: '#/components/schemas/NestedManufacturerRequest'
+ 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
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritablePolicyRequest:
+ type: object
+ description: Policy Serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ assigned_devices:
+ type: array
+ items:
+ $ref: '#/components/schemas/PolicyDeviceM2MNestedRequest'
+ assigned_dynamic_groups:
+ type: array
+ items:
+ $ref: '#/components/schemas/PolicyDynamicGroupM2MNestedRequest'
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ tenant:
+ type: string
+ format: uuid
+ nullable: true
+ required:
+ - id
+ PatchedBulkWritablePolicyRuleRequest:
+ type: object
+ description: PolicyRule Serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ source_users:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ username:
+ type: string
+ minLength: 1
+ description: Signifies the username in identify provider (e.g. john.smith)
+ maxLength: 100
+ name:
+ type: string
+ description: Signifies the name of the user, commonly first & last
+ name (e.g. John Smith)
+ maxLength: 100
+ required:
+ - username
+ source_user_groups:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ user_objects:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ username:
+ type: string
+ minLength: 1
+ description: Signifies the username in identify provider (e.g.
+ john.smith)
+ maxLength: 100
+ name:
+ type: string
+ description: Signifies the name of the user, commonly first
+ & last name (e.g. John Smith)
+ maxLength: 100
+ required:
+ - username
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ required:
+ - name
+ source_addresses:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ ip_range:
+ $ref: '#/components/schemas/NestedIPRangeRequest'
+ fqdn:
+ $ref: '#/components/schemas/NestedFQDNRequest'
+ ip_address:
+ $ref: '#/components/schemas/NestedIPAddressRequest'
+ prefix:
+ $ref: '#/components/schemas/NestedPrefixRequest'
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name descriptor for an address object type.
+ maxLength: 100
+ required:
+ - name
+ source_address_groups:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ address_objects:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ ip_range:
+ $ref: '#/components/schemas/NestedIPRangeRequest'
+ fqdn:
+ $ref: '#/components/schemas/NestedFQDNRequest'
+ ip_address:
+ $ref: '#/components/schemas/NestedIPAddressRequest'
+ prefix:
+ $ref: '#/components/schemas/NestedPrefixRequest'
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name descriptor for an address object type.
+ maxLength: 100
+ required:
+ - name
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name descriptor for a group address objects.
+ maxLength: 100
+ required:
+ - name
+ source_zone:
+ $ref: '#/components/schemas/ZoneRequest'
+ destination_addresses:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ ip_range:
+ $ref: '#/components/schemas/NestedIPRangeRequest'
+ fqdn:
+ $ref: '#/components/schemas/NestedFQDNRequest'
+ ip_address:
+ $ref: '#/components/schemas/NestedIPAddressRequest'
+ prefix:
+ $ref: '#/components/schemas/NestedPrefixRequest'
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name descriptor for an address object type.
+ maxLength: 100
+ required:
+ - name
+ destination_address_groups:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ address_objects:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ ip_range:
+ $ref: '#/components/schemas/NestedIPRangeRequest'
+ fqdn:
+ $ref: '#/components/schemas/NestedFQDNRequest'
+ ip_address:
+ $ref: '#/components/schemas/NestedIPAddressRequest'
+ prefix:
+ $ref: '#/components/schemas/NestedPrefixRequest'
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name descriptor for an address object type.
+ maxLength: 100
+ required:
+ - name
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name descriptor for a group address objects.
+ maxLength: 100
+ required:
+ - name
+ destination_zone:
+ $ref: '#/components/schemas/ZoneRequest'
+ destination_services:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name of the service (e.g. HTTP)
+ maxLength: 100
+ port:
+ type: string
+ nullable: true
+ description: The port or port range to tie to a service (e.g. HTTP
+ would be port 80)
+ maxLength: 20
+ ip_protocol:
+ enum:
+ - ICMP
+ - IGMP
+ - GGP
+ - TCP
+ - CBT
+ - EGP
+ - IGP
+ - BBN-RCC-MON
+ - NVP-II
+ - PUP
+ - EMCON
+ - XNET
+ - CHAOS
+ - UDP
+ - MUX
+ - DCN-MEAS
+ - HMP
+ - PRM
+ - XNS-IDP
+ - TRUNK-1
+ - TRUNK-2
+ - LEAF-1
+ - LEAF-2
+ - RDP
+ - IRTP
+ - ISO-TP4
+ - NETBLT
+ - MFE-NSP
+ - MERIT-INP
+ - DCCP
+ - 3PC
+ - IDPR
+ - XTP
+ - DDP
+ - IDPR-CMTP
+ - TP++
+ - IL
+ - SDRP
+ - IDRP
+ - RSVP
+ - GRE
+ - DSR
+ - BNA
+ - ESP
+ - AH
+ - I-NLSP
+ - NARP
+ - MOBILE
+ - TLSP
+ - SKIP
+ - CFTP
+ - SAT-EXPAK
+ - KRYPTOLAN
+ - RVD
+ - IPPC
+ - SAT-MON
+ - VISA
+ - IPCV
+ - CPNX
+ - CPHB
+ - WSN
+ - PVP
+ - BR-SAT-MON
+ - SUN-ND
+ - WB-MON
+ - WB-EXPAK
+ - ISO-IP
+ - VMTP
+ - SECURE-VMTP
+ - VINES
+ - TTP
+ - NSFNET-IGP
+ - DGP
+ - TCF
+ - EIGRP
+ - OSPFIGP
+ - Sprite-RPC
+ - LARP
+ - MTP
+ - AX.25
+ - IPIP
+ - SCC-SP
+ - ETHERIP
+ - ENCAP
+ - GMTP
+ - IFMP
+ - PNNI
+ - PIM
+ - ARIS
+ - SCPS
+ - QNX
+ - A/N
+ - IPComp
+ - SNP
+ - Compaq-Peer
+ - IPX-in-IP
+ - PGM
+ - L2TP
+ - DDX
+ - IATP
+ - STP
+ - SRP
+ - UTI
+ - SMP
+ - SM
+ - PTP
+ - FIRE
+ - CRTP
+ - CRUDP
+ - SSCOPMCE
+ - IPLT
+ - SPS
+ - PIPE
+ - SCTP
+ - FC
+ - RSVP-E2E-IGNORE
+ - UDPLite
+ - manet
+ - HIP
+ - WESP
+ - ROHC
+ - Ethernet
+ type: string
+ description: IANA IP Protocol (e.g. TCP UDP ICMP)
+ required:
+ - ip_protocol
+ - name
+ destination_service_groups:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ service_objects:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name of the service (e.g. HTTP)
+ maxLength: 100
+ port:
+ type: string
+ nullable: true
+ description: The port or port range to tie to a service (e.g.
+ HTTP would be port 80)
+ maxLength: 20
+ ip_protocol:
+ enum:
+ - ICMP
+ - IGMP
+ - GGP
+ - TCP
+ - CBT
+ - EGP
+ - IGP
+ - BBN-RCC-MON
+ - NVP-II
+ - PUP
+ - EMCON
+ - XNET
+ - CHAOS
+ - UDP
+ - MUX
+ - DCN-MEAS
+ - HMP
+ - PRM
+ - XNS-IDP
+ - TRUNK-1
+ - TRUNK-2
+ - LEAF-1
+ - LEAF-2
+ - RDP
+ - IRTP
+ - ISO-TP4
+ - NETBLT
+ - MFE-NSP
+ - MERIT-INP
+ - DCCP
+ - 3PC
+ - IDPR
+ - XTP
+ - DDP
+ - IDPR-CMTP
+ - TP++
+ - IL
+ - SDRP
+ - IDRP
+ - RSVP
+ - GRE
+ - DSR
+ - BNA
+ - ESP
+ - AH
+ - I-NLSP
+ - NARP
+ - MOBILE
+ - TLSP
+ - SKIP
+ - CFTP
+ - SAT-EXPAK
+ - KRYPTOLAN
+ - RVD
+ - IPPC
+ - SAT-MON
+ - VISA
+ - IPCV
+ - CPNX
+ - CPHB
+ - WSN
+ - PVP
+ - BR-SAT-MON
+ - SUN-ND
+ - WB-MON
+ - WB-EXPAK
+ - ISO-IP
+ - VMTP
+ - SECURE-VMTP
+ - VINES
+ - TTP
+ - NSFNET-IGP
+ - DGP
+ - TCF
+ - EIGRP
+ - OSPFIGP
+ - Sprite-RPC
+ - LARP
+ - MTP
+ - AX.25
+ - IPIP
+ - SCC-SP
+ - ETHERIP
+ - ENCAP
+ - GMTP
+ - IFMP
+ - PNNI
+ - PIM
+ - ARIS
+ - SCPS
+ - QNX
+ - A/N
+ - IPComp
+ - SNP
+ - Compaq-Peer
+ - IPX-in-IP
+ - PGM
+ - L2TP
+ - DDX
+ - IATP
+ - STP
+ - SRP
+ - UTI
+ - SMP
+ - SM
+ - PTP
+ - FIRE
+ - CRTP
+ - CRUDP
+ - SSCOPMCE
+ - IPLT
+ - SPS
+ - PIPE
+ - SCTP
+ - FC
+ - RSVP-E2E-IGNORE
+ - UDPLite
+ - manet
+ - HIP
+ - WESP
+ - ROHC
+ - Ethernet
+ type: string
+ description: IANA IP Protocol (e.g. TCP UDP ICMP)
+ required:
+ - ip_protocol
+ - name
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ required:
+ - name
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ action:
+ $ref: '#/components/schemas/ActionEnum'
+ log:
+ type: boolean
+ request_id:
+ type: string
+ nullable: true
+ maxLength: 100
+ description:
+ type: string
+ nullable: true
+ maxLength: 200
+ index:
+ type: integer
+ maximum: 32767
+ minimum: 0
+ nullable: true
+ required:
+ - id
+ PatchedBulkWritablePowerFeedRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ power_panel:
+ $ref: '#/components/schemas/NestedPowerPanelRequest'
+ rack:
+ allOf:
+ - $ref: '#/components/schemas/NestedRackRequest'
+ nullable: true
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ status:
+ $ref: '#/components/schemas/PowerFeedStatusChoices'
+ type:
+ allOf:
+ - $ref: '#/components/schemas/PowerFeedTypeChoices'
+ default:
+ value: primary
+ label: Primary
+ supply:
+ allOf:
+ - $ref: '#/components/schemas/SupplyEnum'
+ default:
+ value: ac
+ label: AC
+ phase:
+ allOf:
+ - $ref: '#/components/schemas/PhaseEnum'
+ 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
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritablePowerOutletRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ device:
+ $ref: '#/components/schemas/NestedDeviceRequest'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ label:
+ type: string
+ description: Physical label
+ maxLength: 64
+ type:
+ $ref: '#/components/schemas/PowerOutletTypeChoices'
+ power_port:
+ $ref: '#/components/schemas/NestedPowerPortRequest'
+ feed_leg:
+ $ref: '#/components/schemas/FeedLegEnum'
+ description:
+ type: string
+ maxLength: 200
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritablePowerOutletTemplateRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ device_type:
+ $ref: '#/components/schemas/NestedDeviceTypeRequest'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ label:
+ type: string
+ description: Physical label
+ maxLength: 64
+ type:
+ $ref: '#/components/schemas/PowerOutletTypeChoices'
+ power_port:
+ $ref: '#/components/schemas/NestedPowerPortTemplateRequest'
+ feed_leg:
+ $ref: '#/components/schemas/FeedLegEnum'
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritablePowerPanelRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ site:
+ $ref: '#/components/schemas/NestedSiteRequest'
+ location:
+ allOf:
+ - $ref: '#/components/schemas/NestedLocationRequest'
+ nullable: true
+ rack_group:
+ allOf:
+ - $ref: '#/components/schemas/NestedRackGroupRequest'
+ nullable: true
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritablePowerPortRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ device:
+ $ref: '#/components/schemas/NestedDeviceRequest'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ label:
+ type: string
+ description: Physical label
+ maxLength: 64
+ type:
+ $ref: '#/components/schemas/PowerPortTypeChoices'
+ 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
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritablePowerPortTemplateRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ device_type:
+ $ref: '#/components/schemas/NestedDeviceTypeRequest'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ label:
+ type: string
+ description: Physical label
+ maxLength: 64
+ type:
+ $ref: '#/components/schemas/PowerPortTypeChoices'
+ 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: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritablePrefixRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ prefix:
+ type: string
+ minLength: 1
+ site:
+ allOf:
+ - $ref: '#/components/schemas/NestedSiteRequest'
+ nullable: true
+ location:
+ allOf:
+ - $ref: '#/components/schemas/NestedLocationRequest'
+ nullable: true
+ vrf:
+ allOf:
+ - $ref: '#/components/schemas/NestedVRFRequest'
+ nullable: true
+ tenant:
+ allOf:
+ - $ref: '#/components/schemas/NestedTenantRequest'
+ nullable: true
+ vlan:
+ allOf:
+ - $ref: '#/components/schemas/NestedVLANRequest'
+ nullable: true
+ status:
+ $ref: '#/components/schemas/PrefixStatusChoices'
+ role:
+ allOf:
+ - $ref: '#/components/schemas/NestedRoleRequest'
+ 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/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableProviderLCMRequest:
+ type: object
+ description: API serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ 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/TagSerializerFieldRequest'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableProviderNetworkRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ provider:
+ $ref: '#/components/schemas/NestedProviderRequest'
+ name:
+ type: string
+ minLength: 1
+ 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/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableProviderRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ 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/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableRIRRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ 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
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableRackGroupRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ site:
+ $ref: '#/components/schemas/NestedSiteRequest'
+ location:
+ allOf:
+ - $ref: '#/components/schemas/NestedLocationRequest'
+ nullable: true
+ parent:
+ allOf:
+ - $ref: '#/components/schemas/NestedRackGroupRequest'
+ nullable: true
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableRackRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ facility_id:
+ type: string
+ nullable: true
+ description: Locally-assigned identifier
+ maxLength: 50
+ site:
+ $ref: '#/components/schemas/NestedSiteRequest'
+ location:
+ allOf:
+ - $ref: '#/components/schemas/NestedLocationRequest'
+ nullable: true
+ group:
+ allOf:
+ - $ref: '#/components/schemas/NestedRackGroupRequest'
+ nullable: true
+ tenant:
+ allOf:
+ - $ref: '#/components/schemas/NestedTenantRequest'
+ nullable: true
+ status:
+ $ref: '#/components/schemas/RackStatusChoices'
+ role:
+ allOf:
+ - $ref: '#/components/schemas/NestedRackRoleRequest'
+ 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:
+ $ref: '#/components/schemas/RackTypeChoices'
+ width:
+ $ref: '#/components/schemas/WidthEnum'
+ 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:
+ $ref: '#/components/schemas/OuterUnitEnum'
+ comments:
+ type: string
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableRackReservationRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ rack:
+ $ref: '#/components/schemas/NestedRackRequest'
+ units:
+ type: object
+ additionalProperties: {}
+ user:
+ $ref: '#/components/schemas/NestedUserRequest'
+ tenant:
+ allOf:
+ - $ref: '#/components/schemas/NestedTenantRequest'
+ nullable: true
+ description:
+ type: string
+ minLength: 1
+ maxLength: 200
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableRackRoleRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ color:
+ type: string
+ minLength: 1
+ pattern: ^[0-9a-f]{6}$
+ maxLength: 6
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableRearPortRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ device:
+ $ref: '#/components/schemas/NestedDeviceRequest'
+ name:
+ type: string
+ minLength: 1
+ 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
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableRearPortTemplateRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ device_type:
+ $ref: '#/components/schemas/NestedDeviceTypeRequest'
+ name:
+ type: string
+ minLength: 1
+ 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: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableRegionRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ parent:
+ allOf:
+ - $ref: '#/components/schemas/NestedRegionRequest'
+ nullable: true
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableRegularExpressionValidationRuleRequest:
+ type: object
+ description: Serializer for `RegularExpressionValidationRule` objects.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ minLength: 1
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ content_type:
+ type: string
+ field:
+ type: string
+ minLength: 1
+ maxLength: 50
+ regular_expression:
+ type: string
+ minLength: 1
+ enabled:
+ type: boolean
+ error_message:
+ type: string
+ nullable: true
+ description: Optional error message to display when validation fails.
+ maxLength: 255
+ required:
+ - id
+ PatchedBulkWritableRelationshipAssociationRequest:
+ 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
+ relationship:
+ $ref: '#/components/schemas/NestedRelationshipRequest'
+ source_type:
+ type: string
+ source_id:
+ type: string
+ format: uuid
+ destination_type:
+ type: string
+ destination_id:
+ type: string
+ format: uuid
+ required:
+ - id
+ PatchedBulkWritableRelationshipRequest:
+ 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
+ name:
+ type: string
+ minLength: 1
+ description: Name of the relationship as displayed to users
+ maxLength: 100
+ slug:
+ type: string
+ description: Internal relationship name. Please use underscores rather than
+ dashes in this slug.
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ description:
+ type: string
+ maxLength: 200
+ type:
+ allOf:
+ - $ref: '#/components/schemas/RelationshipTypeChoices'
+ description: Cardinality of this relationship
+ required_on:
+ description: Objects on the specified side MUST implement this relationship.
+ Not permitted for symmetric relationships.
+ oneOf:
+ - $ref: '#/components/schemas/RequiredOnEnum'
+ - $ref: '#/components/schemas/BlankEnum'
+ 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: Filterset 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: Filterset filter matching the applicable destination objects
+ of the selected type
+ required:
+ - id
+ PatchedBulkWritableRoleRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ weight:
+ type: integer
+ maximum: 32767
+ minimum: 0
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableRouteTargetRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ description: Route target value (formatted in accordance with RFC 4360)
+ maxLength: 21
+ tenant:
+ allOf:
+ - $ref: '#/components/schemas/NestedTenantRequest'
+ nullable: true
+ description:
+ type: string
+ maxLength: 200
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableSecretRequest:
+ type: object
+ description: Serializer for `Secret` objects.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ description:
+ type: string
+ maxLength: 200
+ provider:
+ type: string
+ minLength: 1
+ maxLength: 100
+ parameters:
+ type: object
+ additionalProperties: {}
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableSecretsGroupAssociationRequest:
+ type: object
+ description: Serializer for `SecretsGroupAssociation` objects.
+ properties:
+ id:
+ type: string
+ format: uuid
+ group:
+ $ref: '#/components/schemas/NestedSecretsGroupRequest'
+ access_type:
+ $ref: '#/components/schemas/AccessTypeEnum'
+ secret_type:
+ $ref: '#/components/schemas/SecretTypeEnum'
+ secret:
+ $ref: '#/components/schemas/NestedSecretRequest'
+ required:
+ - id
+ PatchedBulkWritableSecretsGroupRequest:
+ type: object
+ description: Serializer for `SecretsGroup` objects.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableServiceObjectGroupRequest:
+ type: object
+ description: ServiceObjectGroup Serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ service_objects:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name of the service (e.g. HTTP)
+ maxLength: 100
+ port:
+ type: string
+ nullable: true
+ description: The port or port range to tie to a service (e.g. HTTP
+ would be port 80)
+ maxLength: 20
+ ip_protocol:
+ enum:
+ - ICMP
+ - IGMP
+ - GGP
+ - TCP
+ - CBT
+ - EGP
+ - IGP
+ - BBN-RCC-MON
+ - NVP-II
+ - PUP
+ - EMCON
+ - XNET
+ - CHAOS
+ - UDP
+ - MUX
+ - DCN-MEAS
+ - HMP
+ - PRM
+ - XNS-IDP
+ - TRUNK-1
+ - TRUNK-2
+ - LEAF-1
+ - LEAF-2
+ - RDP
+ - IRTP
+ - ISO-TP4
+ - NETBLT
+ - MFE-NSP
+ - MERIT-INP
+ - DCCP
+ - 3PC
+ - IDPR
+ - XTP
+ - DDP
+ - IDPR-CMTP
+ - TP++
+ - IL
+ - SDRP
+ - IDRP
+ - RSVP
+ - GRE
+ - DSR
+ - BNA
+ - ESP
+ - AH
+ - I-NLSP
+ - NARP
+ - MOBILE
+ - TLSP
+ - SKIP
+ - CFTP
+ - SAT-EXPAK
+ - KRYPTOLAN
+ - RVD
+ - IPPC
+ - SAT-MON
+ - VISA
+ - IPCV
+ - CPNX
+ - CPHB
+ - WSN
+ - PVP
+ - BR-SAT-MON
+ - SUN-ND
+ - WB-MON
+ - WB-EXPAK
+ - ISO-IP
+ - VMTP
+ - SECURE-VMTP
+ - VINES
+ - TTP
+ - NSFNET-IGP
+ - DGP
+ - TCF
+ - EIGRP
+ - OSPFIGP
+ - Sprite-RPC
+ - LARP
+ - MTP
+ - AX.25
+ - IPIP
+ - SCC-SP
+ - ETHERIP
+ - ENCAP
+ - GMTP
+ - IFMP
+ - PNNI
+ - PIM
+ - ARIS
+ - SCPS
+ - QNX
+ - A/N
+ - IPComp
+ - SNP
+ - Compaq-Peer
+ - IPX-in-IP
+ - PGM
+ - L2TP
+ - DDX
+ - IATP
+ - STP
+ - SRP
+ - UTI
+ - SMP
+ - SM
+ - PTP
+ - FIRE
+ - CRTP
+ - CRUDP
+ - SSCOPMCE
+ - IPLT
+ - SPS
+ - PIPE
+ - SCTP
+ - FC
+ - RSVP-E2E-IGNORE
+ - UDPLite
+ - manet
+ - HIP
+ - WESP
+ - ROHC
+ - Ethernet
+ type: string
+ description: IANA IP Protocol (e.g. TCP UDP ICMP)
+ required:
+ - ip_protocol
+ - name
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ required:
+ - id
+ PatchedBulkWritableServiceObjectRequest:
+ type: object
+ description: ServiceObject Serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name of the service (e.g. HTTP)
+ maxLength: 100
+ port:
+ type: string
+ nullable: true
+ description: The port or port range to tie to a service (e.g. HTTP would
+ be port 80)
+ maxLength: 20
+ ip_protocol:
+ allOf:
+ - $ref: '#/components/schemas/IpProtocolEnum'
+ description: IANA IP Protocol (e.g. TCP UDP ICMP)
+ required:
+ - id
+ PatchedBulkWritableServiceRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ device:
+ allOf:
+ - $ref: '#/components/schemas/NestedDeviceRequest'
+ nullable: true
+ virtual_machine:
+ allOf:
+ - $ref: '#/components/schemas/NestedVirtualMachineRequest'
+ nullable: true
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ ports:
+ type: array
+ items:
+ type: integer
+ maximum: 65535
+ minimum: 1
+ protocol:
+ $ref: '#/components/schemas/ProtocolEnum'
+ ipaddresses:
+ type: array
+ items:
+ type: object
+ properties:
+ address:
+ type: string
+ minLength: 1
+ required:
+ - address
+ description:
+ type: string
+ maxLength: 200
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableSiteRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ status:
+ $ref: '#/components/schemas/LocationStatusChoices'
+ region:
+ allOf:
+ - $ref: '#/components/schemas/NestedRegionRequest'
+ nullable: true
+ tenant:
+ allOf:
+ - $ref: '#/components/schemas/NestedTenantRequest'
+ 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/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableSoftwareImageLCMRequest:
+ type: object
+ description: REST API serializer for SoftwareImageLCM records.
+ properties:
+ id:
+ type: string
+ format: uuid
+ image_file_name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ software:
+ $ref: '#/components/schemas/NestedSoftwareLCMRequest'
+ 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/TagSerializerFieldRequest'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableSoftwareLCMRequest:
+ type: object
+ description: REST API serializer for SoftwareLCM records.
+ properties:
+ id:
+ type: string
+ format: uuid
+ device_platform:
+ $ref: '#/components/schemas/NestedPlatformRequest'
+ version:
+ type: string
+ minLength: 1
+ 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:
+ image_file_name:
+ type: string
+ minLength: 1
+ 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
+ required:
+ - image_file_name
+ long_term_support:
+ type: boolean
+ pre_release:
+ type: boolean
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableStatusRequest:
+ type: object
+ description: Serializer for `Status` objects.
+ properties:
+ id:
+ type: string
+ format: uuid
+ content_types:
+ type: array
+ items:
+ type: string
+ name:
+ type: string
+ minLength: 1
+ maxLength: 50
+ slug:
+ type: string
+ maxLength: 50
+ pattern: ^[-a-zA-Z0-9_]+$
+ color:
+ type: string
+ minLength: 1
+ pattern: ^[0-9a-f]{6}$
+ maxLength: 6
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableTagSerializerVersion13Request:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ minLength: 1
+ pattern: ^[-\w]+$
+ maxLength: 100
+ color:
+ type: string
+ minLength: 1
+ pattern: ^[0-9a-f]{6}$
+ maxLength: 6
+ description:
+ type: string
+ maxLength: 200
+ content_types:
+ type: array
+ items:
+ type: string
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableTenantGroupRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ parent:
+ allOf:
+ - $ref: '#/components/schemas/NestedTenantGroupRequest'
+ nullable: true
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableTenantRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ group:
+ $ref: '#/components/schemas/NestedTenantGroupRequest'
+ description:
+ type: string
+ maxLength: 200
+ comments:
+ type: string
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableTokenRequest:
+ 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
+ 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:
+ - id
+ PatchedBulkWritableUserObjectGroupRequest:
+ type: object
+ description: UserObjectGroup Serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ user_objects:
+ type: array
+ items:
+ type: object
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ username:
+ type: string
+ minLength: 1
+ description: Signifies the username in identify provider (e.g. john.smith)
+ maxLength: 100
+ name:
+ type: string
+ description: Signifies the name of the user, commonly first & last
+ name (e.g. John Smith)
+ maxLength: 100
+ required:
+ - username
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ required:
+ - id
+ PatchedBulkWritableUserObjectRequest:
+ type: object
+ description: UserObject Serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ username:
+ type: string
+ minLength: 1
+ description: Signifies the username in identify provider (e.g. john.smith)
+ maxLength: 100
+ name:
+ type: string
+ description: Signifies the name of the user, commonly first & last name
+ (e.g. John Smith)
+ maxLength: 100
+ required:
+ - id
+ PatchedBulkWritableUserRequest:
+ 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
+ username:
+ type: string
+ minLength: 1
+ description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_
+ only.
+ pattern: ^[\w.@+-]+$
+ maxLength: 150
+ password:
+ type: string
+ writeOnly: true
+ minLength: 1
+ 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:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 150
+ required:
+ - name
+ required:
+ - id
+ PatchedBulkWritableVLANGroupRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ site:
+ allOf:
+ - $ref: '#/components/schemas/NestedSiteRequest'
+ nullable: true
+ location:
+ allOf:
+ - $ref: '#/components/schemas/NestedLocationRequest'
+ nullable: true
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableVLANRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ site:
+ allOf:
+ - $ref: '#/components/schemas/NestedSiteRequest'
+ nullable: true
+ location:
+ allOf:
+ - $ref: '#/components/schemas/NestedLocationRequest'
+ nullable: true
+ group:
+ allOf:
+ - $ref: '#/components/schemas/NestedVLANGroupRequest'
+ nullable: true
+ vid:
+ type: integer
+ maximum: 4094
+ minimum: 1
+ title: ID
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ tenant:
+ allOf:
+ - $ref: '#/components/schemas/NestedTenantRequest'
+ nullable: true
+ status:
+ $ref: '#/components/schemas/VLANStatusChoices'
+ role:
+ allOf:
+ - $ref: '#/components/schemas/NestedRoleRequest'
+ nullable: true
+ description:
+ type: string
+ maxLength: 200
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableVMInterfaceRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ virtual_machine:
+ $ref: '#/components/schemas/NestedVirtualMachineRequest'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ enabled:
+ type: boolean
+ status:
+ $ref: '#/components/schemas/InterfaceStatusChoices'
+ parent_interface:
+ allOf:
+ - $ref: '#/components/schemas/NestedVMInterfaceRequest'
+ nullable: true
+ bridge:
+ allOf:
+ - $ref: '#/components/schemas/NestedVMInterfaceRequest'
+ nullable: true
+ mtu:
+ type: integer
+ maximum: 65536
+ minimum: 1
+ nullable: true
+ mac_address:
+ type: string
+ nullable: true
+ maxLength: 18
+ description:
+ type: string
+ maxLength: 200
+ mode:
+ $ref: '#/components/schemas/ModeEnum'
+ untagged_vlan:
+ allOf:
+ - $ref: '#/components/schemas/NestedVLANRequest'
+ nullable: true
+ tagged_vlans:
+ type: array
+ items:
+ type: object
+ properties:
+ vid:
+ type: integer
+ maximum: 4094
+ minimum: 1
+ title: ID
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ required:
+ - name
+ - vid
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableVRFRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ 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/NestedTenantRequest'
+ 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:
+ name:
+ type: string
+ minLength: 1
+ description: Route target value (formatted in accordance with RFC
+ 4360)
+ maxLength: 21
+ required:
+ - name
+ export_targets:
+ type: array
+ items:
+ type: object
+ properties:
+ name:
+ type: string
+ minLength: 1
+ description: Route target value (formatted in accordance with RFC
+ 4360)
+ maxLength: 21
+ required:
+ - name
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableValidatedSoftwareLCMRequest:
+ type: object
+ description: REST API serializer for ValidatedSoftwareLCM records.
+ properties:
+ id:
+ type: string
+ format: uuid
+ software:
+ $ref: '#/components/schemas/NestedSoftwareLCMRequest'
+ 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
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableVirtualChassisRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ domain:
+ type: string
+ maxLength: 30
+ master:
+ allOf:
+ - $ref: '#/components/schemas/NestedDeviceRequest'
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableVirtualMachineWithConfigContextRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ status:
+ $ref: '#/components/schemas/VirtualMachineStatusChoices'
+ cluster:
+ $ref: '#/components/schemas/NestedClusterRequest'
+ role:
+ allOf:
+ - $ref: '#/components/schemas/NestedDeviceRoleRequest'
+ nullable: true
+ tenant:
+ allOf:
+ - $ref: '#/components/schemas/NestedTenantRequest'
+ nullable: true
+ platform:
+ allOf:
+ - $ref: '#/components/schemas/NestedPlatformRequest'
+ nullable: true
+ primary_ip4:
+ allOf:
+ - $ref: '#/components/schemas/NestedIPAddressRequest'
+ nullable: true
+ primary_ip6:
+ allOf:
+ - $ref: '#/components/schemas/NestedIPAddressRequest'
+ 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/NestedConfigContextSchemaRequest'
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableVulnerabilityLCMRequest:
+ type: object
+ description: REST API serializer for VulnerabilityLCM records.
+ properties:
+ id:
+ type: string
+ format: uuid
+ status:
+ $ref: '#/components/schemas/Status4f5Enum'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - id
+ PatchedBulkWritableWebhookRequest:
+ 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
+ content_types:
+ type: array
+ items:
+ type: string
+ name:
+ type: string
+ minLength: 1
+ 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
+ minLength: 1
+ 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
+ minLength: 1
+ description: The complete list of official content types is available here.
+ 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
+ Name: Value. 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: event, model, timestamp,
+ username, request_id, and data.'
+ 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
+ required:
+ - id
+ PatchedBulkWritableZoneRequest:
+ type: object
+ description: Zone Serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ interfaces:
+ type: array
+ items:
+ $ref: '#/components/schemas/NestedInterfaceRequest'
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name of the zone (e.g. trust)
+ maxLength: 100
+ required:
+ - id
+ PatchedCapircaPolicyRequest:
+ type: object
+ description: CapircaPolicy Serializer.
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ pol:
+ type: string
+ nullable: true
+ net:
+ type: string
+ nullable: true
+ svc:
+ type: string
+ nullable: true
+ cfg:
+ type: string
+ nullable: true
+ device:
+ type: string
+ format: uuid
+ nullable: true
+ PatchedCircuitMaintenanceCircuitImpactRequest:
+ type: object
+ description: Serializer for API.
+ properties:
+ 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'
+ PatchedCircuitMaintenanceRequest:
+ type: object
+ description: Serializer for API.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ 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/StatusD95Enum'
+ - $ref: '#/components/schemas/BlankEnum'
+ - $ref: '#/components/schemas/NullEnum'
+ ack:
+ type: boolean
+ nullable: true
+ PatchedCircuitTypeRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedClusterGroupRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedClusterTypeRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedCommandTokenRequest:
+ type: object
+ description: API serializer for interacting with CommandToken objects.
+ properties:
+ comment:
+ type: string
+ description: 'Optional: Enter description of token'
+ maxLength: 255
+ platform:
+ $ref: '#/components/schemas/PlatformEnum'
+ token:
+ type: string
+ minLength: 1
+ description: Token given by chat platform for signing or command validation
+ maxLength: 255
+ PatchedComplianceFeatureRequest:
+ type: object
+ description: Serializer for ComplianceFeature object.
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ minLength: 1
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ description:
+ type: string
+ maxLength: 200
+ PatchedComplianceRuleRequest:
+ type: object
+ description: Serializer for ComplianceRule object.
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _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
+ PatchedComputedFieldRequest:
+ 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:
+ slug:
+ type: string
+ description: Internal field name. Please use underscores rather than dashes
+ in this slug.
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ label:
+ type: string
+ minLength: 1
+ description: Name of the field as displayed to users
+ maxLength: 100
+ description:
+ type: string
+ maxLength: 200
+ content_type:
+ type: string
+ template:
+ type: string
+ minLength: 1
+ 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
+ PatchedConfigComplianceRequest:
+ type: object
+ description: Serializer for ConfigCompliance object.
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _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
+ PatchedConfigContextSchemaRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ 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
+ description:
+ type: string
+ maxLength: 200
+ data_schema:
+ type: object
+ additionalProperties: {}
+ description: A JSON Schema document which is used to validate a config context
+ object.
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedConfigRemoveRequest:
+ type: object
+ description: Serializer for ConfigRemove object.
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 255
+ description:
+ type: string
+ maxLength: 200
+ regex:
+ type: string
+ minLength: 1
+ title: Regex Pattern
+ description: Regex pattern used to remove a line from the backup configuration.
+ maxLength: 200
+ platform:
+ type: string
+ format: uuid
+ PatchedConfigReplaceRequest:
+ type: object
+ description: Serializer for ConfigReplace object.
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 255
+ description:
+ type: string
+ maxLength: 200
+ regex:
+ type: string
+ minLength: 1
+ title: Regex Pattern to Substitute
+ description: Regex pattern that will be found and replaced with 'replaced
+ text'.
+ maxLength: 200
+ replace:
+ type: string
+ minLength: 1
+ title: Replaced Text
+ description: Text that will be inserted in place of Regex pattern match.
+ maxLength: 200
+ platform:
+ type: string
+ format: uuid
+ PatchedCustomFieldSerializerVersion12Request:
+ 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:
+ content_types:
+ type: array
+ items:
+ type: string
+ type:
+ $ref: '#/components/schemas/CustomFieldTypeChoices'
+ label:
+ type: string
+ minLength: 1
+ maxLength: 50
+ name:
+ type: string
+ minLength: 1
+ description: Human-readable unique name of this field.
+ maxLength: 50
+ slug:
+ type: string
+ minLength: 1
+ 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:
+ $ref: '#/components/schemas/FilterLogicEnum'
+ 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, ^[A-Z]{3}$
+ will limit values to exactly three uppercase letters. Regular expression
+ on select and multi-select will be applied at Custom Field Choices
+ definition.
+ maxLength: 500
+ PatchedCustomLinkRequest:
+ 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:
+ target_url:
+ type: string
+ minLength: 1
+ title: URL
+ description: Jinja2 template code for link URL. Reference the object as
+ {{ obj }} such as {{ obj.platform.slug }}.
+ maxLength: 500
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ content_type:
+ type: string
+ text:
+ type: string
+ minLength: 1
+ description: Jinja2 template code for link text. Reference the object as
+ {{ obj }} such as {{ obj.platform.slug }}. 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
+ PatchedDeviceRoleRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ color:
+ type: string
+ minLength: 1
+ 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
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedDynamicGroupRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ 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
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedExportTemplateRequest:
+ type: object
+ description: Extend ValidatedModelSerializer with a `relationships` field.
+ properties:
+ content_type:
+ type: string
+ owner_content_type:
+ type: string
+ nullable: true
+ owner_object_id:
+ type: string
+ format: uuid
+ nullable: true
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ description:
+ type: string
+ maxLength: 200
+ template_code:
+ type: string
+ minLength: 1
+ description: The list of objects being exported is passed as a context variable
+ named queryset.
+ mime_type:
+ type: string
+ description: Defaults to text/plain
+ maxLength: 50
+ file_extension:
+ type: string
+ description: Extension to append to the rendered filename
+ maxLength: 15
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedGoldenConfigRequest:
+ type: object
+ description: Serializer for GoldenConfig object.
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _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
+ PatchedGraphQLQueryRequest:
+ 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:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ query:
+ type: string
+ minLength: 1
+ variables:
+ type: object
+ additionalProperties: {}
+ nullable: true
+ default: {}
+ PatchedGroupRequest:
+ 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:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 150
+ PatchedIPRangeRequest:
+ type: object
+ description: IPRange Serializer.
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ start_address:
+ type: string
+ minLength: 1
+ end_address:
+ type: string
+ minLength: 1
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ vrf:
+ type: string
+ format: uuid
+ nullable: true
+ PatchedImageAttachmentRequest:
+ 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:
+ content_type:
+ type: string
+ object_id:
+ type: string
+ format: uuid
+ name:
+ type: string
+ maxLength: 50
+ image:
+ type: string
+ format: binary
+ image_height:
+ type: integer
+ maximum: 32767
+ minimum: 0
+ image_width:
+ type: integer
+ maximum: 32767
+ minimum: 0
+ PatchedJobHookRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ content_types:
+ type: array
+ items:
+ type: string
+ job:
+ type: string
+ format: uuid
+ description: The job that this job hook will initiate
+ enabled:
+ type: boolean
+ type_create:
+ type: boolean
+ description: Call this job hook when a matching object is created.
+ type_update:
+ type: boolean
+ description: Call this job hook when a matching object is updated.
+ type_delete:
+ type: boolean
+ description: Call this job hook when a matching object is deleted.
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedJobRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ grouping:
+ type: string
+ minLength: 1
+ 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
+ minLength: 1
+ 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
+ enabled:
+ type: boolean
+ description: Whether this job can be executed by users
+ has_sensitive_variables:
+ type: boolean
+ description: Whether this job contains sensitive variables
+ has_sensitive_variables_override:
+ type: boolean
+ description: If set, the configured value will remain even if the underlying
+ Job source code changes
+ 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 SoftTimeLimitExceeded
+ exception.
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.
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
+ task_queues:
+ type: object
+ additionalProperties: {}
+ description: Comma separated list of task queues that this job can run on.
+ A blank list will use the default queue
+ task_queues_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/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedManufacturerRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedMinMaxValidationRuleRequest:
+ type: object
+ description: Serializer for `MinMaxValidationRule` objects.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ minLength: 1
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ content_type:
+ type: string
+ field:
+ type: string
+ minLength: 1
+ 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
+ PatchedNATPolicyRequest:
+ type: object
+ description: NATPolicy Serializer.
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ assigned_devices:
+ type: array
+ items:
+ $ref: '#/components/schemas/NATPolicyDeviceM2MNestedRequest'
+ assigned_dynamic_groups:
+ type: array
+ items:
+ $ref: '#/components/schemas/NATPolicyDynamicGroupM2MNestedRequest'
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ tenant:
+ type: string
+ format: uuid
+ nullable: true
+ PatchedNoteRequest:
+ 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.
+ - ensures that `id` field is always present on the serializer as well
+ - ensures that `created` and `last_updated` fields are always present if applicable to this model and serializer.
+ properties:
+ assigned_object_type:
+ type: string
+ assigned_object_id:
+ type: string
+ format: uuid
+ note:
+ type: string
+ minLength: 1
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ PatchedPeeringRequest:
+ type: object
+ description: REST API serializer for Peering records.
+ properties:
+ status:
+ $ref: '#/components/schemas/CircuitStatusChoices'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ PatchedPeeringRoleRequest:
+ type: object
+ description: REST API serializer for PeeringRole records.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ color:
+ type: string
+ minLength: 1
+ pattern: ^[0-9a-f]{6}$
+ maxLength: 6
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ PatchedPolicyRequest:
+ type: object
+ description: Policy Serializer.
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ assigned_devices:
+ type: array
+ items:
+ $ref: '#/components/schemas/PolicyDeviceM2MNestedRequest'
+ assigned_dynamic_groups:
+ type: array
+ items:
+ $ref: '#/components/schemas/PolicyDynamicGroupM2MNestedRequest'
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ tenant:
+ type: string
+ format: uuid
+ nullable: true
+ PatchedProviderLCMRequest:
+ type: object
+ description: API serializer.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ 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/TagSerializerFieldRequest'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedProviderRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ 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/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedRIRRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ 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
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedRackRoleRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ color:
+ type: string
+ minLength: 1
+ pattern: ^[0-9a-f]{6}$
+ maxLength: 6
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedRegularExpressionValidationRuleRequest:
+ type: object
+ description: Serializer for `RegularExpressionValidationRule` objects.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ minLength: 1
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ content_type:
+ type: string
+ field:
+ type: string
+ minLength: 1
+ maxLength: 50
+ regular_expression:
+ type: string
+ minLength: 1
+ enabled:
+ type: boolean
+ error_message:
+ type: string
+ nullable: true
+ description: Optional error message to display when validation fails.
+ maxLength: 255
+ PatchedRelationshipRequest:
+ 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:
+ name:
+ type: string
+ minLength: 1
+ description: Name of the relationship as displayed to users
+ maxLength: 100
+ slug:
+ type: string
+ description: Internal relationship name. Please use underscores rather than
+ dashes in this slug.
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ description:
+ type: string
+ maxLength: 200
+ type:
+ allOf:
+ - $ref: '#/components/schemas/RelationshipTypeChoices'
+ description: Cardinality of this relationship
+ required_on:
+ description: Objects on the specified side MUST implement this relationship.
+ Not permitted for symmetric relationships.
+ oneOf:
+ - $ref: '#/components/schemas/RequiredOnEnum'
+ - $ref: '#/components/schemas/BlankEnum'
+ 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: Filterset 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: Filterset filter matching the applicable destination objects
+ of the selected type
+ PatchedRoleRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ weight:
+ type: integer
+ maximum: 32767
+ minimum: 0
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedSecretRequest:
+ type: object
+ description: Serializer for `Secret` objects.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ description:
+ type: string
+ maxLength: 200
+ provider:
+ type: string
+ minLength: 1
+ maxLength: 100
+ parameters:
+ type: object
+ additionalProperties: {}
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedSecretsGroupRequest:
+ type: object
+ description: Serializer for `SecretsGroup` objects.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedServiceObjectRequest:
+ type: object
+ description: ServiceObject Serializer.
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name of the service (e.g. HTTP)
+ maxLength: 100
+ port:
+ type: string
+ nullable: true
+ description: The port or port range to tie to a service (e.g. HTTP would
+ be port 80)
+ maxLength: 20
+ ip_protocol:
+ allOf:
+ - $ref: '#/components/schemas/IpProtocolEnum'
+ description: IANA IP Protocol (e.g. TCP UDP ICMP)
+ PatchedStatusRequest:
+ type: object
+ description: Serializer for `Status` objects.
+ properties:
+ content_types:
+ type: array
+ items:
+ type: string
+ name:
+ type: string
+ minLength: 1
+ maxLength: 50
+ slug:
+ type: string
+ maxLength: 50
+ pattern: ^[-a-zA-Z0-9_]+$
+ color:
+ type: string
+ minLength: 1
+ pattern: ^[0-9a-f]{6}$
+ maxLength: 6
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedTagSerializerVersion13Request:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ minLength: 1
+ pattern: ^[-\w]+$
+ maxLength: 100
+ color:
+ type: string
+ minLength: 1
+ pattern: ^[0-9a-f]{6}$
+ maxLength: 6
+ description:
+ type: string
+ maxLength: 200
+ content_types:
+ type: array
+ items:
+ type: string
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedTokenRequest:
+ 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:
+ 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
+ PatchedUserObjectRequest:
+ type: object
+ description: UserObject Serializer.
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ username:
+ type: string
+ minLength: 1
+ description: Signifies the username in identify provider (e.g. john.smith)
+ maxLength: 100
+ name:
+ type: string
+ description: Signifies the name of the user, commonly first & last name
+ (e.g. John Smith)
+ maxLength: 100
+ PatchedVulnerabilityLCMRequest:
+ type: object
+ description: REST API serializer for VulnerabilityLCM records.
+ properties:
+ status:
+ $ref: '#/components/schemas/Status4f5Enum'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWebhookRequest:
+ 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:
+ content_types:
+ type: array
+ items:
+ type: string
+ name:
+ type: string
+ minLength: 1
+ 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
+ minLength: 1
+ 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
+ minLength: 1
+ description: The complete list of official content types is available here.
+ 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
+ Name: Value. 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: event, model, timestamp,
+ username, request_id, and data.'
+ 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
+ PatchedWritableAddressFamilyRequest:
+ type: object
+ description: REST API serializer for AddressFamily records.
+ properties:
+ afi_safi:
+ $ref: '#/components/schemas/AfiSafiEnum'
+ routing_instance:
+ type: string
+ format: uuid
+ title: BGP Routing Instance
+ vrf:
+ type: string
+ format: uuid
+ nullable: true
+ export_policy:
+ type: string
+ maxLength: 100
+ import_policy:
+ type: string
+ maxLength: 100
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ PatchedWritableAddressObjectGroupRequest:
+ type: object
+ description: AddressObjectGroup Serializer.
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name descriptor for a group address objects.
+ maxLength: 100
+ PatchedWritableAddressObjectRequest:
+ type: object
+ description: AddressObject Serializer.
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name descriptor for an address object type.
+ maxLength: 100
+ fqdn:
+ type: string
+ format: uuid
+ nullable: true
+ ip_range:
+ type: string
+ format: uuid
+ nullable: true
+ ip_address:
+ type: string
+ format: uuid
+ nullable: true
+ prefix:
+ type: string
+ format: uuid
+ nullable: true
+ PatchedWritableAggregateRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ prefix:
+ type: string
+ minLength: 1
+ 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/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritableAutonomousSystemRequest:
+ type: object
+ description: REST API serializer for AutonomousSystem records.
+ properties:
+ asn:
+ type: integer
+ maximum: 4294967295
+ minimum: 1
+ format: int64
+ description: 32-bit autonomous system number
+ description:
+ type: string
+ maxLength: 200
+ status:
+ $ref: '#/components/schemas/Status2a0Enum'
+ provider:
+ type: string
+ format: uuid
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ PatchedWritableBGPRoutingInstanceRequest:
+ type: object
+ description: REST API serializer for Peering records.
+ properties:
+ device:
+ type: string
+ format: uuid
+ description:
+ type: string
+ maxLength: 200
+ router_id:
+ type: string
+ format: uuid
+ nullable: true
+ autonomous_system:
+ type: string
+ format: uuid
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ PatchedWritableCVELCMRequest:
+ type: object
+ description: REST API serializer for CVELCM records.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 16
+ published_date:
+ type: string
+ format: date
+ link:
+ type: string
+ format: uri
+ minLength: 1
+ maxLength: 200
+ status:
+ $ref: '#/components/schemas/Status4f5Enum'
+ description:
+ type: string
+ nullable: true
+ maxLength: 255
+ severity:
+ $ref: '#/components/schemas/SeverityEnum'
+ 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/TagSerializerFieldRequest'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritableCableRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ termination_a_type:
+ type: string
+ termination_a_id:
+ type: string
+ format: uuid
+ termination_b_type:
+ type: string
+ termination_b_id:
+ type: string
+ format: uuid
+ type:
+ oneOf:
+ - $ref: '#/components/schemas/CableTypeChoices'
+ - $ref: '#/components/schemas/BlankEnum'
+ status:
+ $ref: '#/components/schemas/CableStatusChoices'
+ 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/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritableCircuitRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ cid:
+ type: string
+ minLength: 1
+ title: Circuit ID
+ maxLength: 100
+ provider:
+ type: string
+ format: uuid
+ type:
+ type: string
+ format: uuid
+ status:
+ $ref: '#/components/schemas/CircuitStatusChoices'
+ 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
+ comments:
+ type: string
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritableCircuitTerminationRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ circuit:
+ type: string
+ format: uuid
+ term_side:
+ allOf:
+ - $ref: '#/components/schemas/TermSideEnum'
+ title: Termination
+ site:
+ type: string
+ format: uuid
+ nullable: true
+ location:
+ 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
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritableClusterRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ 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
+ location:
+ type: string
+ format: uuid
+ nullable: true
+ comments:
+ type: string
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritableConfigContextRequest:
+ 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:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ owner_content_type:
+ type: string
+ nullable: true
+ owner_object_id:
+ type: string
+ format: uuid
+ nullable: 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
+ locations:
+ 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: {}
+ PatchedWritableConsolePortRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ device:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ 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
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritableConsolePortTemplateRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ device_type:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ 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: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritableConsoleServerPortRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ device:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ 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
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritableConsoleServerPortTemplateRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ device_type:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ 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: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritableContactLCMRequest:
+ type: object
+ description: API serializer.
+ properties:
+ name:
+ type: string
+ nullable: true
+ minLength: 1
+ 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/TagSerializerFieldRequest'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritableContractLCMRequest:
+ type: object
+ description: API serializer.
+ properties:
+ provider:
+ type: string
+ format: uuid
+ nullable: true
+ title: Vendor
+ name:
+ type: string
+ minLength: 1
+ 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
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritableCustomFieldChoiceRequest:
+ 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:
+ field:
+ type: string
+ format: uuid
+ value:
+ type: string
+ minLength: 1
+ maxLength: 100
+ weight:
+ type: integer
+ maximum: 32767
+ minimum: 0
+ description: Higher weights appear later in the list
+ PatchedWritableDeviceBayRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ device:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ 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/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritableDeviceBayTemplateRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ device_type:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ label:
+ type: string
+ description: Physical label
+ maxLength: 64
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritableDeviceRedundancyGroupRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ description:
+ type: string
+ maxLength: 200
+ failover_strategy:
+ oneOf:
+ - $ref: '#/components/schemas/FailoverStrategyEnum'
+ - $ref: '#/components/schemas/BlankEnum'
+ secrets_group:
+ type: string
+ format: uuid
+ nullable: true
+ comments:
+ type: string
+ status:
+ $ref: '#/components/schemas/LocationStatusChoices'
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritableDeviceTypeRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ manufacturer:
+ type: string
+ format: uuid
+ model:
+ type: string
+ minLength: 1
+ 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: binary
+ rear_image:
+ type: string
+ format: binary
+ comments:
+ type: string
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritableDeviceWithConfigContextRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ 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
+ location:
+ type: string
+ format: uuid
+ nullable: true
+ 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'
+ status:
+ $ref: '#/components/schemas/DeviceStatusChoices'
+ 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
+ device_redundancy_group:
+ type: string
+ format: uuid
+ nullable: true
+ device_redundancy_group_priority:
+ type: integer
+ maximum: 32767
+ minimum: 1
+ nullable: true
+ description: The priority the device has in the device redundancy group.
+ 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/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritableDynamicGroupMembershipRequest:
+ 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:
+ group:
+ type: string
+ format: uuid
+ parent_group:
+ type: string
+ format: uuid
+ operator:
+ $ref: '#/components/schemas/OperatorEnum'
+ weight:
+ type: integer
+ maximum: 32767
+ minimum: 0
+ PatchedWritableFQDNRequest:
+ type: object
+ description: FQDN Serializer.
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Resolvable fully qualified domain name (e.g. networktocode.com)
+ maxLength: 254
+ PatchedWritableFrontPortRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ device:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ 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
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritableFrontPortTemplateRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ device_type:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ 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: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritableGitRepositoryRequest:
+ type: object
+ description: Git repositories defined as a data source.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ remote_url:
+ type: string
+ format: uri
+ minLength: 1
+ description: Only HTTP and HTTPS URLs are presently supported
+ maxLength: 255
+ branch:
+ type: string
+ minLength: 1
+ maxLength: 64
+ token:
+ type: string
+ writeOnly: true
+ minLength: 1
+ 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'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritableGoldenConfigSettingRequest:
+ type: object
+ description: Serializer for GoldenConfigSetting object.
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ scope:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ minLength: 1
+ 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.
+ 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
+ dynamic_group:
+ type: string
+ format: uuid
+ PatchedWritableHardwareLCMRequest:
+ type: object
+ description: API serializer.
+ properties:
+ 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/TagSerializerFieldRequest'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritableIPAddressRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ address:
+ type: string
+ minLength: 1
+ vrf:
+ type: string
+ format: uuid
+ nullable: true
+ tenant:
+ type: string
+ format: uuid
+ nullable: true
+ status:
+ $ref: '#/components/schemas/IPAddressStatusChoices'
+ 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
+ nat_inside:
+ type: string
+ format: uuid
+ nullable: true
+ title: NAT (Inside)
+ description: The IP Addresses for which this address is the "outside" IP
+ 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/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritableInterfaceRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ device:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ label:
+ type: string
+ description: Physical label
+ maxLength: 64
+ status:
+ $ref: '#/components/schemas/InterfaceStatusChoices'
+ type:
+ $ref: '#/components/schemas/InterfaceTypeChoices'
+ enabled:
+ type: boolean
+ parent_interface:
+ type: string
+ format: uuid
+ nullable: true
+ description: Assigned parent interface
+ bridge:
+ type: string
+ format: uuid
+ nullable: true
+ title: Bridge interface
+ description: Assigned bridge interface
+ lag:
+ type: string
+ format: uuid
+ nullable: true
+ title: Parent LAG
+ description: Assigned LAG interface
+ 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
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritableInterfaceTemplateRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ device_type:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ 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: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritableInventoryItemRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ device:
+ type: string
+ format: uuid
+ parent:
+ type: string
+ format: uuid
+ nullable: true
+ name:
+ type: string
+ minLength: 1
+ 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/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritableLocationRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ status:
+ $ref: '#/components/schemas/LocationStatusChoices'
+ location_type:
+ type: string
+ format: uuid
+ parent:
+ type: string
+ format: uuid
+ nullable: true
+ site:
+ type: string
+ format: uuid
+ nullable: true
+ tenant:
+ type: string
+ format: uuid
+ nullable: true
+ description:
+ type: string
+ maxLength: 200
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritableLocationTypeRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ parent:
+ type: string
+ format: uuid
+ nullable: true
+ nestable:
+ type: boolean
+ description: Allow Locations of this type to be parents/children of other
+ Locations of this same type
+ content_types:
+ type: array
+ items:
+ type: string
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritableNATPolicyRuleRequest:
+ type: object
+ description: PolicyRule Serializer.
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ source_zone:
+ $ref: '#/components/schemas/ZoneRequest'
+ destination_zone:
+ $ref: '#/components/schemas/ZoneRequest'
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ remark:
+ type: boolean
+ log:
+ type: boolean
+ request_id:
+ type: string
+ nullable: true
+ maxLength: 100
+ description:
+ type: string
+ nullable: true
+ maxLength: 200
+ index:
+ type: integer
+ maximum: 32767
+ minimum: 0
+ nullable: true
+ PatchedWritableObjectPermissionRequest:
+ 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:
+ name:
+ type: string
+ minLength: 1
+ 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)
+ PatchedWritablePeerEndpointRequest:
+ type: object
+ description: REST API serializer for PeerEndpoint records.
+ properties:
+ routing_instance:
+ type: string
+ format: uuid
+ nullable: true
+ title: BGP Routing Instance
+ source_ip:
+ type: string
+ format: uuid
+ nullable: true
+ title: BGP Peer IP
+ source_interface:
+ type: string
+ format: uuid
+ nullable: true
+ autonomous_system:
+ type: string
+ format: uuid
+ nullable: true
+ peer_group:
+ type: string
+ format: uuid
+ nullable: true
+ peer:
+ type: string
+ format: uuid
+ nullable: true
+ import_policy:
+ type: string
+ maxLength: 100
+ export_policy:
+ type: string
+ maxLength: 100
+ peering:
+ type: string
+ format: uuid
+ secret:
+ type: string
+ format: uuid
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ enabled:
+ type: boolean
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ PatchedWritablePeerGroupRequest:
+ type: object
+ description: REST API serializer for PeerGroup records.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ source_ip:
+ type: string
+ format: uuid
+ nullable: true
+ title: Source IP Address
+ source_interface:
+ type: string
+ format: uuid
+ nullable: true
+ description:
+ type: string
+ maxLength: 200
+ enabled:
+ type: boolean
+ autonomous_system:
+ type: string
+ format: uuid
+ nullable: true
+ routing_instance:
+ type: string
+ format: uuid
+ template:
+ type: string
+ format: uuid
+ nullable: true
+ secret:
+ type: string
+ format: uuid
+ nullable: true
+ role:
+ type: string
+ format: uuid
+ nullable: true
+ import_policy:
+ type: string
+ maxLength: 100
+ export_policy:
+ type: string
+ maxLength: 100
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ PatchedWritablePeerGroupTemplateRequest:
+ type: object
+ description: REST API serializer for PeerGroup records.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ role:
+ type: string
+ format: uuid
+ nullable: true
+ description:
+ type: string
+ maxLength: 200
+ enabled:
+ type: boolean
+ autonomous_system:
+ type: string
+ format: uuid
+ nullable: true
+ import_policy:
+ type: string
+ maxLength: 100
+ export_policy:
+ type: string
+ maxLength: 100
+ secret:
+ type: string
+ format: uuid
+ nullable: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ PatchedWritablePlatformRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ 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
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritablePolicyRuleRequest:
+ type: object
+ description: PolicyRule Serializer.
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ source_zone:
+ $ref: '#/components/schemas/ZoneRequest'
+ destination_zone:
+ $ref: '#/components/schemas/ZoneRequest'
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ action:
+ $ref: '#/components/schemas/ActionEnum'
+ log:
+ type: boolean
+ request_id:
+ type: string
+ nullable: true
+ maxLength: 100
+ description:
+ type: string
+ nullable: true
+ maxLength: 200
+ index:
+ type: integer
+ maximum: 32767
+ minimum: 0
+ nullable: true
+ PatchedWritablePowerFeedRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ power_panel:
+ type: string
+ format: uuid
+ rack:
+ type: string
+ format: uuid
+ nullable: true
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ status:
+ $ref: '#/components/schemas/PowerFeedStatusChoices'
+ 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
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritablePowerOutletRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ device:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ 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
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritablePowerOutletTemplateRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ device_type:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ 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: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritablePowerPanelRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ site:
+ type: string
+ format: uuid
+ location:
+ type: string
+ format: uuid
+ nullable: true
+ rack_group:
+ type: string
+ format: uuid
+ nullable: true
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritablePowerPortRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ device:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ 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
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritablePowerPortTemplateRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ device_type:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ 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: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritablePrefixRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ prefix:
+ type: string
+ minLength: 1
+ site:
+ type: string
+ format: uuid
+ nullable: true
+ location:
+ 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/PrefixStatusChoices'
+ 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/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritableProviderNetworkRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ provider:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ 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/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritableRackGroupRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ site:
+ type: string
+ format: uuid
+ location:
+ type: string
+ format: uuid
+ nullable: true
+ parent:
+ type: string
+ format: uuid
+ nullable: true
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritableRackRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ facility_id:
+ type: string
+ nullable: true
+ description: Locally-assigned identifier
+ maxLength: 50
+ site:
+ type: string
+ format: uuid
+ location:
+ type: string
+ format: uuid
+ nullable: true
+ group:
+ type: string
+ format: uuid
+ nullable: true
+ description: Assigned group
+ tenant:
+ type: string
+ format: uuid
+ nullable: true
+ status:
+ $ref: '#/components/schemas/RackStatusChoices'
+ 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/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritableRackReservationRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ rack:
+ type: string
+ format: uuid
+ units:
+ type: object
+ additionalProperties: {}
+ user:
+ type: string
+ format: uuid
+ tenant:
+ type: string
+ format: uuid
+ nullable: true
+ description:
+ type: string
+ minLength: 1
+ maxLength: 200
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritableRearPortRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ device:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ 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
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritableRearPortTemplateRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ device_type:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ 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: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritableRegionRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ parent:
+ type: string
+ format: uuid
+ nullable: true
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritableRelationshipAssociationRequest:
+ 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:
+ 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
+ PatchedWritableRouteTargetRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ 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/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritableSecretsGroupAssociationRequest:
+ type: object
+ description: Serializer for `SecretsGroupAssociation` objects.
+ properties:
+ group:
+ type: string
+ format: uuid
+ access_type:
+ $ref: '#/components/schemas/AccessTypeEnum'
+ secret_type:
+ $ref: '#/components/schemas/SecretTypeEnum'
+ secret:
+ type: string
+ format: uuid
+ PatchedWritableServiceObjectGroupRequest:
+ type: object
+ description: ServiceObjectGroup Serializer.
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ PatchedWritableServiceRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ device:
+ type: string
+ format: uuid
+ nullable: true
+ virtual_machine:
+ type: string
+ format: uuid
+ nullable: true
+ name:
+ type: string
+ minLength: 1
+ 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/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritableSiteRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ status:
+ $ref: '#/components/schemas/LocationStatusChoices'
+ 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/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritableSoftwareImageLCMRequest:
+ type: object
+ description: REST API serializer for SoftwareImageLCM records.
+ properties:
+ image_file_name:
+ type: string
+ minLength: 1
+ 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/TagSerializerFieldRequest'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritableSoftwareLCMRequest:
+ type: object
+ description: REST API serializer for SoftwareLCM records.
+ properties:
+ device_platform:
+ type: string
+ format: uuid
+ version:
+ type: string
+ minLength: 1
+ 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/TagSerializerFieldRequest'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritableTenantGroupRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ parent:
+ type: string
+ format: uuid
+ nullable: true
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritableTenantRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ 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/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritableUserObjectGroupRequest:
+ type: object
+ description: UserObjectGroup Serializer.
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ PatchedWritableUserRequest:
+ 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:
+ username:
+ type: string
+ minLength: 1
+ description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_
+ only.
+ pattern: ^[\w.@+-]+$
+ maxLength: 150
+ password:
+ type: string
+ writeOnly: true
+ minLength: 1
+ 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.
+ PatchedWritableVLANGroupRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ site:
+ type: string
+ format: uuid
+ nullable: true
+ location:
+ type: string
+ format: uuid
+ nullable: true
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritableVLANRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ site:
+ type: string
+ format: uuid
+ nullable: true
+ location:
+ 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
+ minLength: 1
+ maxLength: 64
+ tenant:
+ type: string
+ format: uuid
+ nullable: true
+ status:
+ $ref: '#/components/schemas/VLANStatusChoices'
+ role:
+ type: string
+ format: uuid
+ nullable: true
+ description:
+ type: string
+ maxLength: 200
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritableVMInterfaceRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ virtual_machine:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ enabled:
+ type: boolean
+ status:
+ $ref: '#/components/schemas/InterfaceStatusChoices'
+ parent_interface:
+ type: string
+ format: uuid
+ nullable: true
+ description: Assigned parent interface
+ bridge:
+ type: string
+ format: uuid
+ nullable: true
+ title: Bridge interface
+ description: Assigned bridge interface
+ 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/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritableVRFRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ 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/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritableValidatedSoftwareLCMRequest:
+ type: object
+ description: REST API serializer for ValidatedSoftwareLCM records.
+ properties:
+ 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
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritableVirtualChassisRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ domain:
+ type: string
+ maxLength: 30
+ master:
+ type: string
+ format: uuid
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedWritableVirtualMachineWithConfigContextRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ status:
+ $ref: '#/components/schemas/VirtualMachineStatusChoices'
+ 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_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/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ PatchedZoneRequest:
+ type: object
+ description: Zone Serializer.
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ interfaces:
+ type: array
+ items:
+ $ref: '#/components/schemas/NestedInterfaceRequest'
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name of the zone (e.g. trust)
+ maxLength: 100
+ PeerEndpoint:
+ type: object
+ description: REST API serializer for PeerEndpoint records.
+ properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ routing_instance:
+ allOf:
+ - $ref: '#/components/schemas/NestedRoutingInstance'
+ nullable: true
+ source_ip:
+ allOf:
+ - $ref: '#/components/schemas/NestedIPAddress'
+ nullable: true
+ source_interface:
+ allOf:
+ - $ref: '#/components/schemas/NestedInterface'
+ nullable: true
+ autonomous_system:
+ allOf:
+ - $ref: '#/components/schemas/NestedAutonomousSystem'
+ nullable: true
+ peer_group:
+ allOf:
+ - $ref: '#/components/schemas/NestedPeerGroup'
+ nullable: true
+ peer:
+ allOf:
+ - $ref: '#/components/schemas/NestedPeerEndpoint'
+ nullable: true
+ import_policy:
+ type: string
+ maxLength: 100
+ export_policy:
+ type: string
+ maxLength: 100
+ peering:
+ allOf:
+ - $ref: '#/components/schemas/NestedPeering'
+ nullable: true
+ secret:
+ allOf:
+ - $ref: '#/components/schemas/NestedSecret'
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ enabled:
+ type: boolean
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - peering
+ - url
+ PeerGroup:
+ type: object
+ description: REST API serializer for PeerGroup records.
+ properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ maxLength: 100
+ source_ip:
+ allOf:
+ - $ref: '#/components/schemas/NestedIPAddress'
+ nullable: true
+ source_interface:
+ allOf:
+ - $ref: '#/components/schemas/NestedInterface'
+ nullable: true
+ description:
+ type: string
+ maxLength: 200
+ enabled:
+ type: boolean
+ autonomous_system:
+ allOf:
+ - $ref: '#/components/schemas/NestedAutonomousSystem'
+ nullable: true
+ routing_instance:
+ $ref: '#/components/schemas/NestedRoutingInstance'
+ template:
+ allOf:
+ - $ref: '#/components/schemas/NestedPeerGroupTemplate'
+ nullable: true
+ secret:
+ allOf:
+ - $ref: '#/components/schemas/NestedSecret'
+ nullable: true
+ extra_attributes:
+ type: string
+ readOnly: true
+ role:
+ type: string
+ format: uuid
+ nullable: true
+ import_policy:
+ type: string
+ maxLength: 100
+ export_policy:
+ type: string
+ maxLength: 100
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - created
+ - display
+ - extra_attributes
+ - id
+ - last_updated
+ - name
+ - routing_instance
+ - url
+ PeerGroupTemplate:
+ type: object
+ description: REST API serializer for PeerGroup records.
+ properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ maxLength: 100
+ role:
+ type: string
+ format: uuid
+ nullable: true
+ description:
+ type: string
+ maxLength: 200
+ enabled:
+ type: boolean
+ autonomous_system:
+ allOf:
+ - $ref: '#/components/schemas/NestedAutonomousSystem'
+ nullable: true
+ import_policy:
+ type: string
+ maxLength: 100
+ export_policy:
+ type: string
+ maxLength: 100
+ secret:
+ allOf:
+ - $ref: '#/components/schemas/NestedSecret'
+ nullable: true
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - url
+ Peering:
+ type: object
+ description: REST API serializer for Peering records.
+ properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - deprovisioning
+ - offline
+ - planned
+ - provisioning
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Deprovisioning
+ - Offline
+ - Planned
+ - Provisioning
+ endpoints:
+ type: array
+ items:
+ $ref: '#/components/schemas/NestedPeerEndpoint'
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - status
+ - url
+ PeeringRequest:
+ type: object
+ description: REST API serializer for Peering records.
+ properties:
+ status:
+ $ref: '#/components/schemas/CircuitStatusChoices'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - status
+ PeeringRole:
+ type: object
+ description: REST API serializer for PeeringRole records.
+ properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - url
+ PeeringRoleRequest:
+ type: object
+ description: REST API serializer for PeeringRole records.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ color:
+ type: string
+ minLength: 1
+ pattern: ^[0-9a-f]{6}$
+ maxLength: 6
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - name
+ PhaseEnum:
+ type: string
+ enum:
+ - single-phase
+ - three-phase
+ Platform:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ 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
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - created
+ - device_count
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - url
+ - virtualmachine_count
+ PlatformEnum:
+ enum:
+ - mattermost
+ type: string
+ Policy:
+ type: object
+ description: Policy Serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ assigned_devices:
+ type: array
+ items:
+ $ref: '#/components/schemas/PolicyDeviceM2MNested'
+ assigned_dynamic_groups:
+ type: array
+ items:
+ $ref: '#/components/schemas/PolicyDynamicGroupM2MNested'
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ maxLength: 100
+ tenant:
+ type: string
+ format: uuid
+ nullable: true
+ policy_rules:
+ type: array
+ items:
+ type: string
+ format: uuid
+ readOnly: true
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - policy_rules
+ - url
+ PolicyDeviceM2MNested:
+ type: object
+ description: PolicyDeviceM2M NestedSerializer.
+ properties:
+ device:
+ type: string
+ format: uuid
+ weight:
+ type: integer
+ maximum: 32767
+ minimum: 0
+ required:
+ - device
+ PolicyDeviceM2MNestedRequest:
+ type: object
+ description: PolicyDeviceM2M NestedSerializer.
+ properties:
+ device:
+ type: string
+ format: uuid
+ weight:
+ type: integer
+ maximum: 32767
+ minimum: 0
+ required:
+ - id
+ PolicyDynamicGroupM2MNested:
+ type: object
+ description: PolicyDynamicGroupM2M NestedSerializer.
+ properties:
+ dynamic_group:
+ type: string
+ format: uuid
+ weight:
+ type: integer
+ maximum: 32767
+ minimum: 0
+ required:
+ - dynamic_group
+ PolicyDynamicGroupM2MNestedRequest:
+ type: object
+ description: PolicyDynamicGroupM2M NestedSerializer.
+ properties:
+ dynamic_group:
+ type: string
+ format: uuid
+ weight:
+ type: integer
+ maximum: 32767
+ minimum: 0
+ required:
+ - id
+ PolicyRequest:
+ type: object
+ description: Policy Serializer.
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ assigned_devices:
+ type: array
+ items:
+ $ref: '#/components/schemas/PolicyDeviceM2MNestedRequest'
+ assigned_dynamic_groups:
+ type: array
+ items:
+ $ref: '#/components/schemas/PolicyDynamicGroupM2MNestedRequest'
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ tenant:
+ type: string
+ format: uuid
+ nullable: true
+ required:
+ - name
+ PolicyRule:
+ type: object
+ description: PolicyRule Serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ source_users:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ username:
+ type: string
+ description: Signifies the username in identify provider (e.g. john.smith)
+ maxLength: 100
+ name:
+ type: string
+ description: Signifies the name of the user, commonly first & last
+ name (e.g. John Smith)
+ maxLength: 100
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - notes_url
+ - url
+ - username
+ source_user_groups:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ user_objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ username:
+ type: string
+ description: Signifies the username in identify provider (e.g.
+ john.smith)
+ maxLength: 100
+ name:
+ type: string
+ description: Signifies the name of the user, commonly first
+ & last name (e.g. John Smith)
+ maxLength: 100
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - notes_url
+ - url
+ - username
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ maxLength: 100
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - url
+ source_addresses:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ ip_range:
+ $ref: '#/components/schemas/NestedIPRange'
+ fqdn:
+ $ref: '#/components/schemas/NestedFQDN'
+ ip_address:
+ $ref: '#/components/schemas/NestedIPAddress'
+ prefix:
+ $ref: '#/components/schemas/NestedPrefix'
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ description: Name descriptor for an address object type.
+ maxLength: 100
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - url
+ source_address_groups:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ address_objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ ip_range:
+ $ref: '#/components/schemas/NestedIPRange'
+ fqdn:
+ $ref: '#/components/schemas/NestedFQDN'
+ ip_address:
+ $ref: '#/components/schemas/NestedIPAddress'
+ prefix:
+ $ref: '#/components/schemas/NestedPrefix'
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ description: Name descriptor for an address object type.
+ maxLength: 100
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - url
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ description: Name descriptor for a group address objects.
+ maxLength: 100
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - url
+ source_zone:
+ $ref: '#/components/schemas/Zone'
+ destination_addresses:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ ip_range:
+ $ref: '#/components/schemas/NestedIPRange'
+ fqdn:
+ $ref: '#/components/schemas/NestedFQDN'
+ ip_address:
+ $ref: '#/components/schemas/NestedIPAddress'
+ prefix:
+ $ref: '#/components/schemas/NestedPrefix'
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ description: Name descriptor for an address object type.
+ maxLength: 100
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - url
+ destination_address_groups:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ address_objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ ip_range:
+ $ref: '#/components/schemas/NestedIPRange'
+ fqdn:
+ $ref: '#/components/schemas/NestedFQDN'
+ ip_address:
+ $ref: '#/components/schemas/NestedIPAddress'
+ prefix:
+ $ref: '#/components/schemas/NestedPrefix'
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ description: Name descriptor for an address object type.
+ maxLength: 100
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - url
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ description: Name descriptor for a group address objects.
+ maxLength: 100
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - url
+ destination_zone:
+ $ref: '#/components/schemas/Zone'
+ destination_services:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ description: Name of the service (e.g. HTTP)
+ maxLength: 100
+ port:
+ type: string
+ nullable: true
+ description: The port or port range to tie to a service (e.g. HTTP
+ would be port 80)
+ maxLength: 20
+ ip_protocol:
+ enum:
+ - ICMP
+ - IGMP
+ - GGP
+ - TCP
+ - CBT
+ - EGP
+ - IGP
+ - BBN-RCC-MON
+ - NVP-II
+ - PUP
+ - EMCON
+ - XNET
+ - CHAOS
+ - UDP
+ - MUX
+ - DCN-MEAS
+ - HMP
+ - PRM
+ - XNS-IDP
+ - TRUNK-1
+ - TRUNK-2
+ - LEAF-1
+ - LEAF-2
+ - RDP
+ - IRTP
+ - ISO-TP4
+ - NETBLT
+ - MFE-NSP
+ - MERIT-INP
+ - DCCP
+ - 3PC
+ - IDPR
+ - XTP
+ - DDP
+ - IDPR-CMTP
+ - TP++
+ - IL
+ - SDRP
+ - IDRP
+ - RSVP
+ - GRE
+ - DSR
+ - BNA
+ - ESP
+ - AH
+ - I-NLSP
+ - NARP
+ - MOBILE
+ - TLSP
+ - SKIP
+ - CFTP
+ - SAT-EXPAK
+ - KRYPTOLAN
+ - RVD
+ - IPPC
+ - SAT-MON
+ - VISA
+ - IPCV
+ - CPNX
+ - CPHB
+ - WSN
+ - PVP
+ - BR-SAT-MON
+ - SUN-ND
+ - WB-MON
+ - WB-EXPAK
+ - ISO-IP
+ - VMTP
+ - SECURE-VMTP
+ - VINES
+ - TTP
+ - NSFNET-IGP
+ - DGP
+ - TCF
+ - EIGRP
+ - OSPFIGP
+ - Sprite-RPC
+ - LARP
+ - MTP
+ - AX.25
+ - IPIP
+ - SCC-SP
+ - ETHERIP
+ - ENCAP
+ - GMTP
+ - IFMP
+ - PNNI
+ - PIM
+ - ARIS
+ - SCPS
+ - QNX
+ - A/N
+ - IPComp
+ - SNP
+ - Compaq-Peer
+ - IPX-in-IP
+ - PGM
+ - L2TP
+ - DDX
+ - IATP
+ - STP
+ - SRP
+ - UTI
+ - SMP
+ - SM
+ - PTP
+ - FIRE
+ - CRTP
+ - CRUDP
+ - SSCOPMCE
+ - IPLT
+ - SPS
+ - PIPE
+ - SCTP
+ - FC
+ - RSVP-E2E-IGNORE
+ - UDPLite
+ - manet
+ - HIP
+ - WESP
+ - ROHC
+ - Ethernet
+ type: string
+ description: IANA IP Protocol (e.g. TCP UDP ICMP)
+ required:
+ - created
+ - display
+ - id
+ - ip_protocol
+ - last_updated
+ - name
+ - notes_url
+ - url
+ destination_service_groups:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ service_objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ description: Name of the service (e.g. HTTP)
+ maxLength: 100
+ port:
+ type: string
+ nullable: true
+ description: The port or port range to tie to a service (e.g.
+ HTTP would be port 80)
+ maxLength: 20
+ ip_protocol:
+ enum:
+ - ICMP
+ - IGMP
+ - GGP
+ - TCP
+ - CBT
+ - EGP
+ - IGP
+ - BBN-RCC-MON
+ - NVP-II
+ - PUP
+ - EMCON
+ - XNET
+ - CHAOS
+ - UDP
+ - MUX
+ - DCN-MEAS
+ - HMP
+ - PRM
+ - XNS-IDP
+ - TRUNK-1
+ - TRUNK-2
+ - LEAF-1
+ - LEAF-2
+ - RDP
+ - IRTP
+ - ISO-TP4
+ - NETBLT
+ - MFE-NSP
+ - MERIT-INP
+ - DCCP
+ - 3PC
+ - IDPR
+ - XTP
+ - DDP
+ - IDPR-CMTP
+ - TP++
+ - IL
+ - SDRP
+ - IDRP
+ - RSVP
+ - GRE
+ - DSR
+ - BNA
+ - ESP
+ - AH
+ - I-NLSP
+ - NARP
+ - MOBILE
+ - TLSP
+ - SKIP
+ - CFTP
+ - SAT-EXPAK
+ - KRYPTOLAN
+ - RVD
+ - IPPC
+ - SAT-MON
+ - VISA
+ - IPCV
+ - CPNX
+ - CPHB
+ - WSN
+ - PVP
+ - BR-SAT-MON
+ - SUN-ND
+ - WB-MON
+ - WB-EXPAK
+ - ISO-IP
+ - VMTP
+ - SECURE-VMTP
+ - VINES
+ - TTP
+ - NSFNET-IGP
+ - DGP
+ - TCF
+ - EIGRP
+ - OSPFIGP
+ - Sprite-RPC
+ - LARP
+ - MTP
+ - AX.25
+ - IPIP
+ - SCC-SP
+ - ETHERIP
+ - ENCAP
+ - GMTP
+ - IFMP
+ - PNNI
+ - PIM
+ - ARIS
+ - SCPS
+ - QNX
+ - A/N
+ - IPComp
+ - SNP
+ - Compaq-Peer
+ - IPX-in-IP
+ - PGM
+ - L2TP
+ - DDX
+ - IATP
+ - STP
+ - SRP
+ - UTI
+ - SMP
+ - SM
+ - PTP
+ - FIRE
+ - CRTP
+ - CRUDP
+ - SSCOPMCE
+ - IPLT
+ - SPS
+ - PIPE
+ - SCTP
+ - FC
+ - RSVP-E2E-IGNORE
+ - UDPLite
+ - manet
+ - HIP
+ - WESP
+ - ROHC
+ - Ethernet
+ type: string
+ description: IANA IP Protocol (e.g. TCP UDP ICMP)
+ required:
+ - created
+ - display
+ - id
+ - ip_protocol
+ - last_updated
+ - name
+ - notes_url
+ - url
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ maxLength: 100
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - url
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ name:
+ type: string
+ maxLength: 100
+ action:
+ $ref: '#/components/schemas/ActionEnum'
+ log:
+ type: boolean
+ request_id:
+ type: string
+ nullable: true
+ maxLength: 100
+ description:
+ type: string
+ nullable: true
+ maxLength: 200
+ index:
+ type: integer
+ maximum: 32767
+ minimum: 0
+ nullable: true
+ source_services:
+ type: array
+ items:
+ type: string
+ format: uuid
+ readOnly: true
+ source_service_groups:
+ type: array
+ items:
+ type: string
+ format: uuid
+ readOnly: true
+ required:
+ - action
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - source_service_groups
+ - source_services
+ - url
+ PortTypeChoices:
+ 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
+ PowerFeed:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ 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
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - cable
+ - cable_peer
+ - cable_peer_type
+ - connected_endpoint
+ - connected_endpoint_reachable
+ - connected_endpoint_type
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - power_panel
+ - status
+ - url
+ PowerFeedStatusChoices:
+ type: string
+ enum:
+ - active
+ - failed
+ - offline
+ - planned
+ PowerFeedTypeChoices:
+ type: string
+ enum:
+ - primary
+ - redundant
+ PowerOutlet:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ 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
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - cable
+ - cable_peer
+ - cable_peer_type
+ - connected_endpoint
+ - connected_endpoint_reachable
+ - connected_endpoint_type
+ - created
+ - device
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - url
+ PowerOutletTemplate:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ 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
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - created
+ - device_type
+ - display
+ - id
+ - last_updated
+ - name
+ - url
+ PowerOutletTypeChoices:
+ 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
+ PowerPanel:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ site:
+ $ref: '#/components/schemas/NestedSite'
+ location:
+ allOf:
+ - $ref: '#/components/schemas/NestedLocation'
+ nullable: true
+ rack_group:
+ allOf:
+ - $ref: '#/components/schemas/NestedRackGroup'
+ nullable: true
+ name:
+ type: string
+ maxLength: 100
+ powerfeed_count:
+ type: integer
+ readOnly: true
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - powerfeed_count
+ - site
+ - url
+ PowerPort:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ 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
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - cable
+ - cable_peer
+ - cable_peer_type
+ - connected_endpoint
+ - connected_endpoint_reachable
+ - connected_endpoint_type
+ - created
+ - device
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - url
+ PowerPortTemplate:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ 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
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - created
+ - device_type
+ - display
+ - id
+ - last_updated
+ - name
+ - url
+ PowerPortTypeChoices:
+ 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
+ Prefix:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ 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
+ location:
+ allOf:
+ - $ref: '#/components/schemas/NestedLocation'
+ 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
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - created
+ - display
+ - family
+ - id
+ - last_updated
+ - notes_url
+ - prefix
+ - status
+ - url
+ PrefixLengthRequest:
+ type: object
+ properties:
+ prefix_length:
+ type: integer
+ required:
+ - prefix_length
+ PrefixStatusChoices:
+ type: string
+ enum:
+ - active
+ - container
+ - deprecated
+ - p2p
+ - reserved
+ ProtocolEnum:
+ type: string
+ enum:
+ - tcp
+ - udp
+ 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: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ 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
+ circuit_count:
+ type: integer
+ readOnly: true
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - circuit_count
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - url
+ ProviderLCM:
+ type: object
+ description: API serializer.
+ properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ 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'
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - url
+ ProviderLCMRequest:
+ type: object
+ description: API serializer.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ 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/TagSerializerFieldRequest'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - name
+ ProviderNetwork:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ 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
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - provider
+ - url
+ ProviderRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ 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/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - name
+ RIR:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ 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
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - aggregate_count
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - url
+ RIRRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ 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
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - name
+ Rack:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ name:
+ type: string
+ maxLength: 100
+ facility_id:
+ type: string
+ nullable: true
+ description: Locally-assigned identifier
+ maxLength: 50
+ site:
+ $ref: '#/components/schemas/NestedSite'
+ location:
+ allOf:
+ - $ref: '#/components/schemas/NestedLocation'
+ nullable: true
+ 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
+ device_count:
+ type: integer
+ readOnly: true
+ powerfeed_count:
+ type: integer
+ readOnly: true
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - created
+ - device_count
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - powerfeed_count
+ - site
+ - status
+ - url
+ RackGroup:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ name:
+ type: string
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ site:
+ $ref: '#/components/schemas/NestedSite'
+ location:
+ allOf:
+ - $ref: '#/components/schemas/NestedLocation'
+ nullable: true
+ 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'
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - _depth
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - rack_count
+ - site
+ - url
+ RackReservation:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ rack:
+ $ref: '#/components/schemas/NestedRack'
+ units:
+ type: object
+ additionalProperties: {}
+ user:
+ $ref: '#/components/schemas/NestedUser'
+ tenant:
+ allOf:
+ - $ref: '#/components/schemas/NestedTenant'
+ nullable: true
+ description:
+ type: string
+ maxLength: 200
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - created
+ - description
+ - display
+ - id
+ - last_updated
+ - notes_url
+ - rack
+ - units
+ - url
+ - user
+ RackRole:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ 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
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - rack_count
+ - url
+ RackRoleRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ color:
+ type: string
+ minLength: 1
+ pattern: ^[0-9a-f]{6}$
+ maxLength: 6
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - name
+ RackStatusChoices:
+ type: string
+ enum:
+ - active
+ - available
+ - deprecated
+ - planned
+ - reserved
+ RackTypeChoices:
+ type: string
+ enum:
+ - 2-post-frame
+ - 4-post-frame
+ - 4-post-cabinet
+ - wall-frame
+ - wall-cabinet
+ 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: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ 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
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - cable
+ - cable_peer
+ - cable_peer_type
+ - created
+ - device
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - type
+ - url
+ RearPortTemplate:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ 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
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - created
+ - device_type
+ - display
+ - id
+ - last_updated
+ - name
+ - type
+ - url
+ Region:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ 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'
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - _depth
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - site_count
+ - url
+ RegularExpressionValidationRule:
+ type: object
+ description: Serializer for `RegularExpressionValidationRule` objects.
+ properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ required:
+ - content_type
+ - created
+ - display
+ - field
+ - id
+ - last_updated
+ - name
+ - regular_expression
+ - slug
+ - url
+ RegularExpressionValidationRuleRequest:
+ type: object
+ description: Serializer for `RegularExpressionValidationRule` objects.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ minLength: 1
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ content_type:
+ type: string
+ field:
+ type: string
+ minLength: 1
+ maxLength: 50
+ regular_expression:
+ type: string
+ minLength: 1
+ enabled:
+ type: boolean
+ error_message:
+ type: string
+ nullable: true
+ description: Optional error message to display when validation fails.
+ maxLength: 255
+ required:
+ - content_type
+ - field
+ - name
+ - regular_expression
+ - slug
+ Relationship:
+ 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
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ description: Name of the relationship as displayed to users
+ maxLength: 100
+ slug:
+ type: string
+ description: Internal relationship name. Please use underscores rather than
+ dashes in this slug.
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ description:
+ type: string
+ maxLength: 200
+ type:
+ allOf:
+ - $ref: '#/components/schemas/RelationshipTypeChoices'
+ description: Cardinality of this relationship
+ required_on:
+ description: Objects on the specified side MUST implement this relationship.
+ Not permitted for symmetric relationships.
+ oneOf:
+ - $ref: '#/components/schemas/RequiredOnEnum'
+ - $ref: '#/components/schemas/BlankEnum'
+ 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: Filterset 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: Filterset filter matching the applicable destination objects
+ of the selected type
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ required:
+ - created
+ - destination_type
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - source_type
+ - url
+ RelationshipAssociation:
+ 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
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ url:
+ type: string
+ format: uri
+ 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
+ - display
+ - id
+ - relationship
+ - source_id
+ - source_type
+ - url
+ RelationshipRequest:
+ 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:
+ name:
+ type: string
+ minLength: 1
+ description: Name of the relationship as displayed to users
+ maxLength: 100
+ slug:
+ type: string
+ description: Internal relationship name. Please use underscores rather than
+ dashes in this slug.
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ description:
+ type: string
+ maxLength: 200
+ type:
+ allOf:
+ - $ref: '#/components/schemas/RelationshipTypeChoices'
+ description: Cardinality of this relationship
+ required_on:
+ description: Objects on the specified side MUST implement this relationship.
+ Not permitted for symmetric relationships.
+ oneOf:
+ - $ref: '#/components/schemas/RequiredOnEnum'
+ - $ref: '#/components/schemas/BlankEnum'
+ 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: Filterset 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: Filterset filter matching the applicable destination objects
+ of the selected type
+ required:
+ - destination_type
+ - name
+ - source_type
+ RelationshipTypeChoices:
+ enum:
+ - one-to-one
+ - symmetric-one-to-one
+ - one-to-many
+ - many-to-many
+ - symmetric-many-to-many
+ type: string
+ RequiredOnEnum:
+ enum:
+ - source
+ - destination
+ type: string
+ Role:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ 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
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - prefix_count
+ - url
+ - vlan_count
+ RoleEnum:
+ type: string
+ enum:
+ - loopback
+ - secondary
+ - anycast
+ - vip
+ - vrrp
+ - hsrp
+ - glbp
+ - carp
+ RoleRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ weight:
+ type: integer
+ maximum: 32767
+ minimum: 0
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - name
+ RouteTarget:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ 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
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - url
+ ScheduledJob:
+ 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.
+ - ensures that `id` field is always present on the serializer as well
+ - ensures that `created` and `last_updated` fields are always present if applicable to this model and serializer.
+ 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
+ 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/JobExecutionTypeIntervalChoices'
+ 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
+ nullable: 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
+ nullable: true
+ title: Approval date/time
+ description: Datetime that the schedule was approved
+ crontab:
+ type: string
+ title: Custom cronjob
+ description: Cronjob syntax string for custom scheduling
+ maxLength: 255
+ required:
+ - approved_at
+ - approved_by_user
+ - date_changed
+ - display
+ - 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
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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: {}
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - provider
+ - url
+ SecretRequest:
+ type: object
+ description: Serializer for `Secret` objects.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ description:
+ type: string
+ maxLength: 200
+ provider:
+ type: string
+ minLength: 1
+ maxLength: 100
+ parameters:
+ type: object
+ additionalProperties: {}
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - name
+ - provider
+ 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
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - secrets
+ - url
+ SecretsGroupAssociation:
+ type: object
+ description: Serializer for `SecretsGroupAssociation` objects.
+ 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
+ group:
+ $ref: '#/components/schemas/NestedSecretsGroup'
+ access_type:
+ $ref: '#/components/schemas/AccessTypeEnum'
+ secret_type:
+ $ref: '#/components/schemas/SecretTypeEnum'
+ secret:
+ $ref: '#/components/schemas/NestedSecret'
+ required:
+ - access_type
+ - display
+ - group
+ - id
+ - secret
+ - secret_type
+ - url
+ SecretsGroupRequest:
+ type: object
+ description: Serializer for `SecretsGroup` objects.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - name
+ Service:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ family:
+ type: integer
+ readOnly: true
+ address:
+ type: string
+ required:
+ - address
+ - display
+ - family
+ - id
+ - url
+ description:
+ type: string
+ maxLength: 200
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - ports
+ - url
+ ServiceObject:
+ type: object
+ description: ServiceObject Serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ description: Name of the service (e.g. HTTP)
+ maxLength: 100
+ port:
+ type: string
+ nullable: true
+ description: The port or port range to tie to a service (e.g. HTTP would
+ be port 80)
+ maxLength: 20
+ ip_protocol:
+ allOf:
+ - $ref: '#/components/schemas/IpProtocolEnum'
+ description: IANA IP Protocol (e.g. TCP UDP ICMP)
+ required:
+ - created
+ - display
+ - id
+ - ip_protocol
+ - last_updated
+ - name
+ - notes_url
+ - url
+ ServiceObjectGroup:
+ type: object
+ description: ServiceObjectGroup Serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ service_objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ description: Name of the service (e.g. HTTP)
+ maxLength: 100
+ port:
+ type: string
+ nullable: true
+ description: The port or port range to tie to a service (e.g. HTTP
+ would be port 80)
+ maxLength: 20
+ ip_protocol:
+ enum:
+ - ICMP
+ - IGMP
+ - GGP
+ - TCP
+ - CBT
+ - EGP
+ - IGP
+ - BBN-RCC-MON
+ - NVP-II
+ - PUP
+ - EMCON
+ - XNET
+ - CHAOS
+ - UDP
+ - MUX
+ - DCN-MEAS
+ - HMP
+ - PRM
+ - XNS-IDP
+ - TRUNK-1
+ - TRUNK-2
+ - LEAF-1
+ - LEAF-2
+ - RDP
+ - IRTP
+ - ISO-TP4
+ - NETBLT
+ - MFE-NSP
+ - MERIT-INP
+ - DCCP
+ - 3PC
+ - IDPR
+ - XTP
+ - DDP
+ - IDPR-CMTP
+ - TP++
+ - IL
+ - SDRP
+ - IDRP
+ - RSVP
+ - GRE
+ - DSR
+ - BNA
+ - ESP
+ - AH
+ - I-NLSP
+ - NARP
+ - MOBILE
+ - TLSP
+ - SKIP
+ - CFTP
+ - SAT-EXPAK
+ - KRYPTOLAN
+ - RVD
+ - IPPC
+ - SAT-MON
+ - VISA
+ - IPCV
+ - CPNX
+ - CPHB
+ - WSN
+ - PVP
+ - BR-SAT-MON
+ - SUN-ND
+ - WB-MON
+ - WB-EXPAK
+ - ISO-IP
+ - VMTP
+ - SECURE-VMTP
+ - VINES
+ - TTP
+ - NSFNET-IGP
+ - DGP
+ - TCF
+ - EIGRP
+ - OSPFIGP
+ - Sprite-RPC
+ - LARP
+ - MTP
+ - AX.25
+ - IPIP
+ - SCC-SP
+ - ETHERIP
+ - ENCAP
+ - GMTP
+ - IFMP
+ - PNNI
+ - PIM
+ - ARIS
+ - SCPS
+ - QNX
+ - A/N
+ - IPComp
+ - SNP
+ - Compaq-Peer
+ - IPX-in-IP
+ - PGM
+ - L2TP
+ - DDX
+ - IATP
+ - STP
+ - SRP
+ - UTI
+ - SMP
+ - SM
+ - PTP
+ - FIRE
+ - CRTP
+ - CRUDP
+ - SSCOPMCE
+ - IPLT
+ - SPS
+ - PIPE
+ - SCTP
+ - FC
+ - RSVP-E2E-IGNORE
+ - UDPLite
+ - manet
+ - HIP
+ - WESP
+ - ROHC
+ - Ethernet
+ type: string
+ description: IANA IP Protocol (e.g. TCP UDP ICMP)
+ required:
+ - created
+ - display
+ - id
+ - ip_protocol
+ - last_updated
+ - name
+ - notes_url
+ - url
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ maxLength: 100
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - url
+ ServiceObjectRequest:
+ type: object
+ description: ServiceObject Serializer.
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name of the service (e.g. HTTP)
+ maxLength: 100
+ port:
+ type: string
+ nullable: true
+ description: The port or port range to tie to a service (e.g. HTTP would
+ be port 80)
+ maxLength: 20
+ ip_protocol:
+ allOf:
+ - $ref: '#/components/schemas/IpProtocolEnum'
+ description: IANA IP Protocol (e.g. TCP UDP ICMP)
+ required:
+ - ip_protocol
+ - name
+ SeverityEnum:
+ type: string
+ enum:
+ - Critical
+ - High
+ - Medium
+ - Low
+ - None
+ Site:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ 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
+ 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
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - circuit_count
+ - created
+ - device_count
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - prefix_count
+ - rack_count
+ - status
+ - url
+ - virtualmachine_count
+ - vlan_count
+ SoftwareImageLCM:
+ type: object
+ description: REST API serializer for SoftwareImageLCM records.
+ properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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'
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ required:
+ - created
+ - display
+ - id
+ - image_file_name
+ - last_updated
+ - software
+ - url
+ SoftwareLCM:
+ type: object
+ description: REST API serializer for SoftwareLCM records.
+ properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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
+ 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'
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ required:
+ - created
+ - device_platform
+ - display
+ - id
+ - last_updated
+ - url
+ - version
+ Status:
+ type: object
+ description: Serializer for `Status` objects.
+ 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
+ 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
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - content_types
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - url
+ Status2a0Enum:
+ type: string
+ enum:
+ - active
+ - available
+ - planned
+ Status4f5Enum:
+ type: string
+ enum: []
+ Status8f7Enum:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ StatusD95Enum:
+ enum:
+ - TENTATIVE
+ - CONFIRMED
+ - CANCELLED
+ - IN-PROCESS
+ - COMPLETED
+ - RE-SCHEDULED
+ - UNKNOWN
+ type: string
+ StatusRequest:
+ type: object
+ description: Serializer for `Status` objects.
+ properties:
+ content_types:
+ type: array
+ items:
+ type: string
+ name:
+ type: string
+ minLength: 1
+ maxLength: 50
+ slug:
+ type: string
+ maxLength: 50
+ pattern: ^[-a-zA-Z0-9_]+$
+ color:
+ type: string
+ minLength: 1
+ pattern: ^[0-9a-f]{6}$
+ maxLength: 6
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - content_types
+ - name
+ SubdeviceRoleEnum:
+ type: string
+ enum:
+ - parent
+ - child
+ SupplyEnum:
+ type: string
+ enum:
+ - ac
+ - dc
+ TagSerializerField:
+ type: object
+ description: NestedSerializer field for `Tag` object fields.
+ properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ maxLength: 100
+ slug:
+ type: string
+ pattern: ^[-\w]+$
+ maxLength: 100
+ color:
+ type: string
+ pattern: ^[0-9a-f]{6}$
+ maxLength: 6
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - slug
+ - url
+ TagSerializerFieldRequest:
+ type: object
+ description: NestedSerializer field for `Tag` object fields.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ minLength: 1
+ pattern: ^[-\w]+$
+ maxLength: 100
+ color:
+ type: string
+ minLength: 1
+ pattern: ^[0-9a-f]{6}$
+ maxLength: 6
+ required:
+ - id
+ TagSerializerVersion13:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ name:
+ type: string
+ maxLength: 100
+ slug:
+ type: string
+ pattern: ^[-\w]+$
+ maxLength: 100
+ 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
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - content_types
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - slug
+ - tagged_items
+ - url
+ TagSerializerVersion13Request:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ minLength: 1
+ pattern: ^[-\w]+$
+ maxLength: 100
+ color:
+ type: string
+ minLength: 1
+ pattern: ^[0-9a-f]{6}$
+ maxLength: 6
+ description:
+ type: string
+ maxLength: 200
+ content_types:
+ type: array
+ items:
+ type: string
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - content_types
+ - name
+ - slug
+ Tenant:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ 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
+ 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
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - circuit_count
+ - cluster_count
+ - created
+ - device_count
+ - display
+ - id
+ - ipaddress_count
+ - last_updated
+ - name
+ - notes_url
+ - prefix_count
+ - rack_count
+ - site_count
+ - url
+ - virtualmachine_count
+ - vlan_count
+ - vrf_count
+ TenantGroup:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ 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'
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - _depth
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - 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
+ TokenRequest:
+ 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:
+ 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
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ id:
+ type: integer
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ maxLength: 150
+ required:
+ - display
+ - id
+ - name
+ - url
+ required:
+ - display
+ - id
+ - url
+ - username
+ UserObject:
+ type: object
+ description: UserObject Serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ username:
+ type: string
+ description: Signifies the username in identify provider (e.g. john.smith)
+ maxLength: 100
+ name:
+ type: string
+ description: Signifies the name of the user, commonly first & last name
+ (e.g. John Smith)
+ maxLength: 100
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - notes_url
+ - url
+ - username
+ UserObjectGroup:
+ type: object
+ description: UserObjectGroup Serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ user_objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ username:
+ type: string
+ description: Signifies the username in identify provider (e.g. john.smith)
+ maxLength: 100
+ name:
+ type: string
+ description: Signifies the name of the user, commonly first & last
+ name (e.g. John Smith)
+ maxLength: 100
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - notes_url
+ - url
+ - username
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ maxLength: 100
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - url
+ UserObjectRequest:
+ type: object
+ description: UserObject Serializer.
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ username:
+ type: string
+ minLength: 1
+ description: Signifies the username in identify provider (e.g. john.smith)
+ maxLength: 100
+ name:
+ type: string
+ description: Signifies the name of the user, commonly first & last name
+ (e.g. John Smith)
+ maxLength: 100
+ required:
+ - username
+ VLAN:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ site:
+ allOf:
+ - $ref: '#/components/schemas/NestedSite'
+ nullable: true
+ location:
+ allOf:
+ - $ref: '#/components/schemas/NestedLocation'
+ 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
+ prefix_count:
+ type: integer
+ readOnly: true
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - prefix_count
+ - status
+ - url
+ - vid
+ VLANGroup:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ name:
+ type: string
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ site:
+ allOf:
+ - $ref: '#/components/schemas/NestedSite'
+ nullable: true
+ location:
+ allOf:
+ - $ref: '#/components/schemas/NestedLocation'
+ nullable: true
+ description:
+ type: string
+ maxLength: 200
+ vlan_count:
+ type: integer
+ readOnly: true
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - url
+ - vlan_count
+ VLANStatusChoices:
+ type: string
+ enum:
+ - active
+ - deprecated
+ - reserved
+ VMInterfaceSerializerVersion12:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ virtual_machine:
+ $ref: '#/components/schemas/NestedVirtualMachine'
+ name:
+ type: string
+ maxLength: 64
+ enabled:
+ type: boolean
+ parent_interface:
+ allOf:
+ - $ref: '#/components/schemas/NestedVMInterface'
+ nullable: true
+ bridge:
+ allOf:
+ - $ref: '#/components/schemas/NestedVMInterface'
+ nullable: true
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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
+ required:
+ - display
+ - id
+ - name
+ - url
+ - vid
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - display
+ - id
+ - name
+ - notes_url
+ - url
+ - virtual_machine
+ VRF:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ 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:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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
+ required:
+ - display
+ - id
+ - name
+ - url
+ export_targets:
+ type: array
+ items:
+ type: object
+ properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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
+ required:
+ - display
+ - id
+ - name
+ - url
+ ipaddress_count:
+ type: integer
+ readOnly: true
+ prefix_count:
+ type: integer
+ readOnly: true
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - created
+ - display
+ - id
+ - ipaddress_count
+ - last_updated
+ - name
+ - notes_url
+ - prefix_count
+ - url
+ ValidatedSoftwareLCM:
+ type: object
+ description: REST API serializer for ValidatedSoftwareLCM records.
+ properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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'
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - software
+ - start
+ - url
+ - valid
+ VirtualChassis:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ name:
+ type: string
+ maxLength: 64
+ domain:
+ type: string
+ maxLength: 30
+ master:
+ allOf:
+ - $ref: '#/components/schemas/NestedDevice'
+ nullable: true
+ member_count:
+ type: integer
+ readOnly: true
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - member_count
+ - name
+ - notes_url
+ - url
+ VirtualMachineStatusChoices:
+ type: string
+ enum:
+ - active
+ - decommissioning
+ - failed
+ - offline
+ - planned
+ - staged
+ VirtualMachineWithConfigContext:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ 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
+ 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
+ location:
+ allOf:
+ - $ref: '#/components/schemas/NestedLocation'
+ readOnly: true
+ nullable: 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
+ config_context:
+ type: object
+ additionalProperties: {}
+ readOnly: true
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - cluster
+ - config_context
+ - created
+ - display
+ - id
+ - last_updated
+ - location
+ - name
+ - notes_url
+ - 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'
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ required:
+ - created
+ - cve
+ - device
+ - display
+ - id
+ - inventory_item
+ - last_updated
+ - software
+ - status
+ - url
+ VulnerabilityLCMRequest:
+ type: object
+ description: REST API serializer for VulnerabilityLCM records.
+ properties:
+ status:
+ $ref: '#/components/schemas/Status4f5Enum'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - status
+ 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
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ 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 here.
+ 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
+ Name: Value. 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: event, model, timestamp,
+ username, request_id, and data.'
+ 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
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ required:
+ - content_types
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - payload_url
+ - url
+ WebhookRequest:
+ 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:
+ content_types:
+ type: array
+ items:
+ type: string
+ name:
+ type: string
+ minLength: 1
+ 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
+ minLength: 1
+ 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
+ minLength: 1
+ description: The complete list of official content types is available here.
+ 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
+ Name: Value. 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: event, model, timestamp,
+ username, request_id, and data.'
+ 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
+ required:
+ - content_types
+ - name
+ - payload_url
+ WidthEnum:
+ type: integer
+ enum:
+ - 10
+ - 19
+ - 21
+ - 23
+ WritableAddressFamilyRequest:
+ type: object
+ description: REST API serializer for AddressFamily records.
+ properties:
+ afi_safi:
+ $ref: '#/components/schemas/AfiSafiEnum'
+ routing_instance:
+ type: string
+ format: uuid
+ title: BGP Routing Instance
+ vrf:
+ type: string
+ format: uuid
+ nullable: true
+ export_policy:
+ type: string
+ maxLength: 100
+ import_policy:
+ type: string
+ maxLength: 100
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - afi_safi
+ - routing_instance
+ WritableAddressObjectGroupRequest:
+ type: object
+ description: AddressObjectGroup Serializer.
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name descriptor for a group address objects.
+ maxLength: 100
+ required:
+ - name
+ WritableAddressObjectRequest:
+ type: object
+ description: AddressObject Serializer.
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name descriptor for an address object type.
+ maxLength: 100
+ fqdn:
+ type: string
+ format: uuid
+ nullable: true
+ ip_range:
+ type: string
+ format: uuid
+ nullable: true
+ ip_address:
+ type: string
+ format: uuid
+ nullable: true
+ prefix:
+ type: string
+ format: uuid
+ nullable: true
+ required:
+ - name
+ WritableAggregateRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ prefix:
+ type: string
+ minLength: 1
+ 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/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - prefix
+ - rir
+ WritableAutonomousSystemRequest:
+ type: object
+ description: REST API serializer for AutonomousSystem records.
+ properties:
+ asn:
+ type: integer
+ maximum: 4294967295
+ minimum: 1
+ format: int64
+ description: 32-bit autonomous system number
+ description:
+ type: string
+ maxLength: 200
+ status:
+ $ref: '#/components/schemas/Status2a0Enum'
+ provider:
+ type: string
+ format: uuid
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - asn
+ - status
+ WritableBGPRoutingInstanceRequest:
+ type: object
+ description: REST API serializer for Peering records.
+ properties:
+ device:
+ type: string
+ format: uuid
+ description:
+ type: string
+ maxLength: 200
+ router_id:
+ type: string
+ format: uuid
+ nullable: true
+ autonomous_system:
+ type: string
+ format: uuid
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - autonomous_system
+ - device
+ WritableCVELCMRequest:
+ type: object
+ description: REST API serializer for CVELCM records.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 16
+ published_date:
+ type: string
+ format: date
+ link:
+ type: string
+ format: uri
+ minLength: 1
+ maxLength: 200
+ status:
+ $ref: '#/components/schemas/Status4f5Enum'
+ description:
+ type: string
+ nullable: true
+ maxLength: 255
+ severity:
+ $ref: '#/components/schemas/SeverityEnum'
+ 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/TagSerializerFieldRequest'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - link
+ - name
+ - published_date
+ WritableCableRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ termination_a_type:
+ type: string
+ termination_a_id:
+ type: string
+ format: uuid
+ termination_b_type:
+ type: string
+ termination_b_id:
+ type: string
+ format: uuid
+ type:
+ oneOf:
+ - $ref: '#/components/schemas/CableTypeChoices'
+ - $ref: '#/components/schemas/BlankEnum'
+ status:
+ $ref: '#/components/schemas/CableStatusChoices'
+ 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/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - status
+ - termination_a_id
+ - termination_a_type
+ - termination_b_id
+ - termination_b_type
+ WritableCircuitRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ cid:
+ type: string
+ minLength: 1
+ title: Circuit ID
+ maxLength: 100
+ provider:
+ type: string
+ format: uuid
+ type:
+ type: string
+ format: uuid
+ status:
+ $ref: '#/components/schemas/CircuitStatusChoices'
+ 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
+ comments:
+ type: string
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - cid
+ - provider
+ - status
+ - type
+ WritableCircuitTerminationRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ circuit:
+ type: string
+ format: uuid
+ term_side:
+ allOf:
+ - $ref: '#/components/schemas/TermSideEnum'
+ title: Termination
+ site:
+ type: string
+ format: uuid
+ nullable: true
+ location:
+ 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
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - circuit
+ - term_side
+ WritableClusterRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ 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
+ location:
+ type: string
+ format: uuid
+ nullable: true
+ comments:
+ type: string
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - name
+ - type
+ WritableConfigContextRequest:
+ 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:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ owner_content_type:
+ type: string
+ nullable: true
+ owner_object_id:
+ type: string
+ format: uuid
+ nullable: 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
+ locations:
+ 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: {}
+ required:
+ - data
+ - name
+ WritableConsolePortRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ device:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ 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
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - device
+ - name
+ WritableConsolePortTemplateRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ device_type:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ 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: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - device_type
+ - name
+ WritableConsoleServerPortRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ device:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ 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
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - device
+ - name
+ WritableConsoleServerPortTemplateRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ device_type:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ 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: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - device_type
+ - name
+ WritableContactLCMRequest:
+ type: object
+ description: API serializer.
+ properties:
+ name:
+ type: string
+ nullable: true
+ minLength: 1
+ 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/TagSerializerFieldRequest'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - contract
+ - name
+ WritableContractLCMRequest:
+ type: object
+ description: API serializer.
+ properties:
+ provider:
+ type: string
+ format: uuid
+ nullable: true
+ title: Vendor
+ name:
+ type: string
+ minLength: 1
+ 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
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - name
+ WritableCustomFieldChoiceRequest:
+ 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:
+ field:
+ type: string
+ format: uuid
+ value:
+ type: string
+ minLength: 1
+ maxLength: 100
+ weight:
+ type: integer
+ maximum: 32767
+ minimum: 0
+ description: Higher weights appear later in the list
+ required:
+ - field
+ - value
+ WritableDeviceBayRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ device:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ 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/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - device
+ - name
+ WritableDeviceBayTemplateRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ device_type:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ label:
+ type: string
+ description: Physical label
+ maxLength: 64
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - device_type
+ - name
+ WritableDeviceRedundancyGroupRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ description:
+ type: string
+ maxLength: 200
+ failover_strategy:
+ oneOf:
+ - $ref: '#/components/schemas/FailoverStrategyEnum'
+ - $ref: '#/components/schemas/BlankEnum'
+ secrets_group:
+ type: string
+ format: uuid
+ nullable: true
+ comments:
+ type: string
+ status:
+ $ref: '#/components/schemas/LocationStatusChoices'
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - name
+ - status
+ WritableDeviceTypeRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ manufacturer:
+ type: string
+ format: uuid
+ model:
+ type: string
+ minLength: 1
+ 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: binary
+ rear_image:
+ type: string
+ format: binary
+ comments:
+ type: string
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - manufacturer
+ - model
+ WritableDeviceWithConfigContextRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ 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
+ location:
+ type: string
+ format: uuid
+ nullable: true
+ 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'
+ status:
+ $ref: '#/components/schemas/DeviceStatusChoices'
+ 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
+ device_redundancy_group:
+ type: string
+ format: uuid
+ nullable: true
+ device_redundancy_group_priority:
+ type: integer
+ maximum: 32767
+ minimum: 1
+ nullable: true
+ description: The priority the device has in the device redundancy group.
+ 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/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - device_role
+ - device_type
+ - site
+ - status
+ WritableDynamicGroupMembershipRequest:
+ 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:
+ group:
+ type: string
+ format: uuid
+ parent_group:
+ type: string
+ format: uuid
+ operator:
+ $ref: '#/components/schemas/OperatorEnum'
+ weight:
+ type: integer
+ maximum: 32767
+ minimum: 0
+ required:
+ - group
+ - operator
+ - parent_group
+ - weight
+ WritableFQDNRequest:
+ type: object
+ description: FQDN Serializer.
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Resolvable fully qualified domain name (e.g. networktocode.com)
+ maxLength: 254
+ required:
+ - name
+ WritableFrontPortRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ device:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ 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
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - device
+ - name
+ - rear_port
+ - type
+ WritableFrontPortTemplateRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ device_type:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ 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: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - device_type
+ - name
+ - rear_port
+ - type
+ WritableGitRepositoryRequest:
+ type: object
+ description: Git repositories defined as a data source.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ remote_url:
+ type: string
+ format: uri
+ minLength: 1
+ description: Only HTTP and HTTPS URLs are presently supported
+ maxLength: 255
+ branch:
+ type: string
+ minLength: 1
+ maxLength: 64
+ token:
+ type: string
+ writeOnly: true
+ minLength: 1
+ 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'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - name
+ - remote_url
+ WritableGoldenConfigSettingRequest:
+ type: object
+ description: Serializer for GoldenConfigSetting object.
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ scope:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ minLength: 1
+ 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.
+ 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
+ dynamic_group:
+ type: string
+ format: uuid
+ required:
+ - dynamic_group
+ - name
+ - slug
+ WritableHardwareLCMRequest:
+ type: object
+ description: API serializer.
+ properties:
+ 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/TagSerializerFieldRequest'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ WritableIPAddressRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ address:
+ type: string
+ minLength: 1
+ vrf:
+ type: string
+ format: uuid
+ nullable: true
+ tenant:
+ type: string
+ format: uuid
+ nullable: true
+ status:
+ $ref: '#/components/schemas/IPAddressStatusChoices'
+ 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
+ nat_inside:
+ type: string
+ format: uuid
+ nullable: true
+ title: NAT (Inside)
+ description: The IP Addresses for which this address is the "outside" IP
+ 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/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - address
+ - status
+ WritableInterfaceRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ device:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ label:
+ type: string
+ description: Physical label
+ maxLength: 64
+ status:
+ $ref: '#/components/schemas/InterfaceStatusChoices'
+ type:
+ $ref: '#/components/schemas/InterfaceTypeChoices'
+ enabled:
+ type: boolean
+ parent_interface:
+ type: string
+ format: uuid
+ nullable: true
+ description: Assigned parent interface
+ bridge:
+ type: string
+ format: uuid
+ nullable: true
+ title: Bridge interface
+ description: Assigned bridge interface
+ lag:
+ type: string
+ format: uuid
+ nullable: true
+ title: Parent LAG
+ description: Assigned LAG interface
+ 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
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - device
+ - name
+ - status
+ - type
+ WritableInterfaceTemplateRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ device_type:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ 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: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - device_type
+ - name
+ - type
+ WritableInventoryItemRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ device:
+ type: string
+ format: uuid
+ parent:
+ type: string
+ format: uuid
+ nullable: true
+ name:
+ type: string
+ minLength: 1
+ 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/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - device
+ - name
+ WritableLocationRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ status:
+ $ref: '#/components/schemas/LocationStatusChoices'
+ location_type:
+ type: string
+ format: uuid
+ parent:
+ type: string
+ format: uuid
+ nullable: true
+ site:
+ type: string
+ format: uuid
+ nullable: true
+ tenant:
+ type: string
+ format: uuid
+ nullable: true
+ description:
+ type: string
+ maxLength: 200
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - location_type
+ - name
+ - status
+ WritableLocationTypeRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ parent:
+ type: string
+ format: uuid
+ nullable: true
+ nestable:
+ type: boolean
+ description: Allow Locations of this type to be parents/children of other
+ Locations of this same type
+ content_types:
+ type: array
+ items:
+ type: string
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - name
+ WritableNATPolicyRuleRequest:
+ type: object
+ description: PolicyRule Serializer.
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ source_zone:
+ $ref: '#/components/schemas/ZoneRequest'
+ destination_zone:
+ $ref: '#/components/schemas/ZoneRequest'
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ remark:
+ type: boolean
+ log:
+ type: boolean
+ request_id:
+ type: string
+ nullable: true
+ maxLength: 100
+ description:
+ type: string
+ nullable: true
+ maxLength: 200
+ index:
+ type: integer
+ maximum: 32767
+ minimum: 0
+ nullable: true
+ required:
+ - name
+ WritableObjectPermissionRequest:
+ 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:
+ name:
+ type: string
+ minLength: 1
+ 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)
+ required:
+ - actions
+ - name
+ - object_types
+ WritablePeerEndpointRequest:
+ type: object
+ description: REST API serializer for PeerEndpoint records.
+ properties:
+ routing_instance:
+ type: string
+ format: uuid
+ nullable: true
+ title: BGP Routing Instance
+ source_ip:
+ type: string
+ format: uuid
+ nullable: true
+ title: BGP Peer IP
+ source_interface:
+ type: string
+ format: uuid
+ nullable: true
+ autonomous_system:
+ type: string
+ format: uuid
+ nullable: true
+ peer_group:
+ type: string
+ format: uuid
+ nullable: true
+ peer:
+ type: string
+ format: uuid
+ nullable: true
+ import_policy:
+ type: string
+ maxLength: 100
+ export_policy:
+ type: string
+ maxLength: 100
+ peering:
+ type: string
+ format: uuid
+ secret:
+ type: string
+ format: uuid
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ enabled:
+ type: boolean
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - peering
+ WritablePeerGroupRequest:
+ type: object
+ description: REST API serializer for PeerGroup records.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ source_ip:
+ type: string
+ format: uuid
+ nullable: true
+ title: Source IP Address
+ source_interface:
+ type: string
+ format: uuid
+ nullable: true
+ description:
+ type: string
+ maxLength: 200
+ enabled:
+ type: boolean
+ autonomous_system:
+ type: string
+ format: uuid
+ nullable: true
+ routing_instance:
+ type: string
+ format: uuid
+ template:
+ type: string
+ format: uuid
+ nullable: true
+ secret:
+ type: string
+ format: uuid
+ nullable: true
+ role:
+ type: string
+ format: uuid
+ nullable: true
+ import_policy:
+ type: string
+ maxLength: 100
+ export_policy:
+ type: string
+ maxLength: 100
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - name
+ - routing_instance
+ WritablePeerGroupTemplateRequest:
+ type: object
+ description: REST API serializer for PeerGroup records.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ role:
+ type: string
+ format: uuid
+ nullable: true
+ description:
+ type: string
+ maxLength: 200
+ enabled:
+ type: boolean
+ autonomous_system:
+ type: string
+ format: uuid
+ nullable: true
+ import_policy:
+ type: string
+ maxLength: 100
+ export_policy:
+ type: string
+ maxLength: 100
+ secret:
+ type: string
+ format: uuid
+ nullable: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ required:
+ - name
+ WritablePlatformRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ 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
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - name
+ WritablePolicyRuleRequest:
+ type: object
+ description: PolicyRule Serializer.
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ source_zone:
+ $ref: '#/components/schemas/ZoneRequest'
+ destination_zone:
+ $ref: '#/components/schemas/ZoneRequest'
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ action:
+ $ref: '#/components/schemas/ActionEnum'
+ log:
+ type: boolean
+ request_id:
+ type: string
+ nullable: true
+ maxLength: 100
+ description:
+ type: string
+ nullable: true
+ maxLength: 200
+ index:
+ type: integer
+ maximum: 32767
+ minimum: 0
+ nullable: true
+ required:
+ - action
+ - name
+ WritablePowerFeedRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ power_panel:
+ type: string
+ format: uuid
+ rack:
+ type: string
+ format: uuid
+ nullable: true
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ status:
+ $ref: '#/components/schemas/PowerFeedStatusChoices'
+ 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
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - name
+ - power_panel
+ - status
+ WritablePowerOutletRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ device:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ 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
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - device
+ - name
+ WritablePowerOutletTemplateRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ device_type:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ 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: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - device_type
+ - name
+ WritablePowerPanelRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ site:
+ type: string
+ format: uuid
+ location:
+ type: string
+ format: uuid
+ nullable: true
+ rack_group:
+ type: string
+ format: uuid
+ nullable: true
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - name
+ - site
+ WritablePowerPortRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ device:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ 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
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - device
+ - name
+ WritablePowerPortTemplateRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ device_type:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ 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: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - device_type
+ - name
+ WritablePrefixRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ prefix:
+ type: string
+ minLength: 1
+ site:
+ type: string
+ format: uuid
+ nullable: true
+ location:
+ 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/PrefixStatusChoices'
+ 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/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - prefix
+ - status
+ WritableProviderNetworkRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ provider:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ 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/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - name
+ - provider
+ WritableRackGroupRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ site:
+ type: string
+ format: uuid
+ location:
+ type: string
+ format: uuid
+ nullable: true
+ parent:
+ type: string
+ format: uuid
+ nullable: true
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - name
+ - site
+ WritableRackRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ facility_id:
+ type: string
+ nullable: true
+ description: Locally-assigned identifier
+ maxLength: 50
+ site:
+ type: string
+ format: uuid
+ location:
+ type: string
+ format: uuid
+ nullable: true
+ group:
+ type: string
+ format: uuid
+ nullable: true
+ description: Assigned group
+ tenant:
+ type: string
+ format: uuid
+ nullable: true
+ status:
+ $ref: '#/components/schemas/RackStatusChoices'
+ 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/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - name
+ - site
+ - status
+ WritableRackReservationRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ rack:
+ type: string
+ format: uuid
+ units:
+ type: object
+ additionalProperties: {}
+ user:
+ type: string
+ format: uuid
+ tenant:
+ type: string
+ format: uuid
+ nullable: true
+ description:
+ type: string
+ minLength: 1
+ maxLength: 200
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - description
+ - rack
+ - units
+ - user
+ WritableRearPortRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ device:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ 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
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - device
+ - name
+ - type
+ WritableRearPortTemplateRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ device_type:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ 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: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - device_type
+ - name
+ - type
+ WritableRegionRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ parent:
+ type: string
+ format: uuid
+ nullable: true
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - name
+ WritableRelationshipAssociationRequest:
+ 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:
+ 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
+ - relationship
+ - source_id
+ - source_type
+ WritableRouteTargetRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ 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/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - name
+ WritableSecretsGroupAssociationRequest:
+ type: object
+ description: Serializer for `SecretsGroupAssociation` objects.
+ properties:
+ group:
+ type: string
+ format: uuid
+ access_type:
+ $ref: '#/components/schemas/AccessTypeEnum'
+ secret_type:
+ $ref: '#/components/schemas/SecretTypeEnum'
+ secret:
+ type: string
+ format: uuid
+ required:
+ - access_type
+ - group
+ - secret
+ - secret_type
+ WritableServiceObjectGroupRequest:
+ type: object
+ description: ServiceObjectGroup Serializer.
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ required:
+ - name
+ WritableServiceRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ device:
+ type: string
+ format: uuid
+ nullable: true
+ virtual_machine:
+ type: string
+ format: uuid
+ nullable: true
+ name:
+ type: string
+ minLength: 1
+ 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/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - name
+ - ports
+ - protocol
+ WritableSiteRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ status:
+ $ref: '#/components/schemas/LocationStatusChoices'
+ 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/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - name
+ - status
+ WritableSoftwareImageLCMRequest:
+ type: object
+ description: REST API serializer for SoftwareImageLCM records.
+ properties:
+ image_file_name:
+ type: string
+ minLength: 1
+ 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/TagSerializerFieldRequest'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - image_file_name
+ - software
+ WritableSoftwareLCMRequest:
+ type: object
+ description: REST API serializer for SoftwareLCM records.
+ properties:
+ device_platform:
+ type: string
+ format: uuid
+ version:
+ type: string
+ minLength: 1
+ 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/TagSerializerFieldRequest'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - device_platform
+ - software_images
+ - version
+ WritableTenantGroupRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ parent:
+ type: string
+ format: uuid
+ nullable: true
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - name
+ WritableTenantRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ 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/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - name
+ WritableUserObjectGroupRequest:
+ type: object
+ description: UserObjectGroup Serializer.
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ required:
+ - name
+ WritableUserRequest:
+ 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:
+ username:
+ type: string
+ minLength: 1
+ description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_
+ only.
+ pattern: ^[\w.@+-]+$
+ maxLength: 150
+ password:
+ type: string
+ writeOnly: true
+ minLength: 1
+ 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.
+ required:
+ - password
+ - username
+ WritableVLANGroupRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ site:
+ type: string
+ format: uuid
+ nullable: true
+ location:
+ type: string
+ format: uuid
+ nullable: true
+ description:
+ type: string
+ maxLength: 200
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - name
+ WritableVLANRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ site:
+ type: string
+ format: uuid
+ nullable: true
+ location:
+ 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
+ minLength: 1
+ maxLength: 64
+ tenant:
+ type: string
+ format: uuid
+ nullable: true
+ status:
+ $ref: '#/components/schemas/VLANStatusChoices'
+ role:
+ type: string
+ format: uuid
+ nullable: true
+ description:
+ type: string
+ maxLength: 200
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - name
+ - status
+ - vid
+ WritableVMInterfaceRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ virtual_machine:
+ type: string
+ format: uuid
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ enabled:
+ type: boolean
+ status:
+ $ref: '#/components/schemas/InterfaceStatusChoices'
+ parent_interface:
+ type: string
+ format: uuid
+ nullable: true
+ description: Assigned parent interface
+ bridge:
+ type: string
+ format: uuid
+ nullable: true
+ title: Bridge interface
+ description: Assigned bridge interface
+ 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/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - name
+ - status
+ - virtual_machine
+ WritableVRFRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ 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/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - name
+ WritableValidatedSoftwareLCMRequest:
+ type: object
+ description: REST API serializer for ValidatedSoftwareLCM records.
+ properties:
+ 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
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - software
+ - start
+ WritableVirtualChassisRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ domain:
+ type: string
+ maxLength: 30
+ master:
+ type: string
+ format: uuid
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - name
+ WritableVirtualMachineWithConfigContextRequest:
+ type: object
+ description: |-
+ Base class to use for serializers based on OrganizationalModel or PrimaryModel.
+
+ Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.
+ properties:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 64
+ status:
+ $ref: '#/components/schemas/VirtualMachineStatusChoices'
+ 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_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/TagSerializerFieldRequest'
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ required:
+ - cluster
+ - name
+ - status
+ Zone:
+ type: object
+ description: Zone Serializer.
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ status:
+ type: object
+ properties:
+ value:
+ type: string
+ enum:
+ - active
+ - decommissioned
+ - staged
+ label:
+ type: string
+ enum:
+ - Active
+ - Decommissioned
+ - Staged
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ interfaces:
+ type: array
+ items:
+ $ref: '#/components/schemas/NestedInterface'
+ created:
+ type: string
+ format: date
+ readOnly: true
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ description: Name of the zone (e.g. trust)
+ maxLength: 100
+ vrfs:
+ type: array
+ items:
+ type: string
+ format: uuid
+ readOnly: true
+ required:
+ - created
+ - display
+ - id
+ - last_updated
+ - name
+ - notes_url
+ - url
+ - vrfs
+ ZoneRequest:
+ type: object
+ description: Zone Serializer.
+ properties:
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ status:
+ $ref: '#/components/schemas/Status8f7Enum'
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ interfaces:
+ type: array
+ items:
+ $ref: '#/components/schemas/NestedInterfaceRequest'
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
+ type: string
+ maxLength: 200
+ name:
+ type: string
+ minLength: 1
+ description: Name of the zone (e.g. trust)
+ maxLength: 100
+ required:
+ - id
+ 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