diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
index bc5c57c..40573ab 100644
--- a/.github/workflows/test.yml
+++ b/.github/workflows/test.yml
@@ -5,12 +5,12 @@ name: Tests
on:
pull_request:
paths-ignore:
- - 'README.md'
+ - "README.md"
push:
paths-ignore:
- - 'README.md'
+ - "README.md"
# For systems with an upstream API that could drift unexpectedly (like most SaaS systems, etc.),
- # we recommend testing at a regular interval not necessarily tied to code changes. This will
+ # we recommend testing at a regular interval not necessarily tied to code changes. This will
# ensure you are alerted to something breaking due to an API change, even if the code did not
# change.
# schedule:
@@ -22,23 +22,22 @@ jobs:
runs-on: ubuntu-latest
timeout-minutes: 5
steps:
+ - name: Set up Go
+ uses: actions/setup-go@v3
+ with:
+ go-version: "1.20"
+ id: go
- - name: Set up Go
- uses: actions/setup-go@v3
- with:
- go-version: '1.16'
- id: go
+ - name: Check out code into the Go module directory
+ uses: actions/checkout@v3
- - name: Check out code into the Go module directory
- uses: actions/checkout@v3
+ - name: Get dependencies
+ run: |
+ go mod download
- - name: Get dependencies
- run: |
- go mod download
-
- - name: Build
- run: |
- go build -v .
+ - name: Build
+ run: |
+ go build -v .
generate:
runs-on: ubuntu-latest
@@ -46,7 +45,7 @@ jobs:
- uses: actions/checkout@v3
- uses: actions/setup-go@v3
with:
- go-version-file: 'go.mod'
+ go-version-file: "go.mod"
cache: true
- run: go generate ./...
- name: git diff
@@ -65,41 +64,40 @@ jobs:
matrix:
# list whatever Terraform versions here you would like to support
terraform:
- - '0.12.*'
- - '0.13.*'
- - '0.14.*'
- - '0.15.*'
- - '1.0.*'
- - '1.1.*'
+ - "0.12.*"
+ - "0.13.*"
+ - "0.14.*"
+ - "0.15.*"
+ - "1.0.*"
+ - "1.1.*"
steps:
+ - name: Set up Go
+ uses: actions/setup-go@v3
+ with:
+ go-version: "1.20"
+ id: go
- - name: Set up Go
- uses: actions/setup-go@v3
- with:
- go-version: '1.17'
- id: go
+ - uses: hashicorp/setup-terraform@v2
+ with:
+ terraform_version: ${{ matrix.terraform }}
+ terraform_wrapper: false
- - uses: hashicorp/setup-terraform@v2
- with:
- terraform_version: ${{ matrix.terraform }}
- terraform_wrapper: false
+ - name: Check out code into the Go module directory
+ uses: actions/checkout@v3
- - name: Check out code into the Go module directory
- uses: actions/checkout@v3
+ - name: Get dependencies
+ run: |
+ go mod download
- - name: Get dependencies
- run: |
- go mod download
-
- - name: TF acceptance tests
- timeout-minutes: 10
- env:
- TF_ACC: "1"
+ - name: TF acceptance tests
+ timeout-minutes: 10
+ env:
+ TF_ACC: "1"
- # Set whatever additional acceptance test env vars here. You can
- # optionally use data from your repository secrets using the
- # following syntax:
- # SOME_VAR: ${{ secrets.SOME_VAR }}
+ # Set whatever additional acceptance test env vars here. You can
+ # optionally use data from your repository secrets using the
+ # following syntax:
+ # SOME_VAR: ${{ secrets.SOME_VAR }}
- run: |
- go test -v -cover ./internal/provider/
\ No newline at end of file
+ run: |
+ go test -v -cover ./internal/provider/
diff --git a/client/swagger.yaml b/client/swagger.yaml
index 584531d..a9bf5d3 100644
--- a/client/swagger.yaml
+++ b/client/swagger.yaml
@@ -1,7 +1,7 @@
openapi: 3.0.3
info:
title: API Documentation
- version: 1.3.2 (1.3)
+ version: 1.5.7 (1.3)
description: Source of truth and network automation platform
license:
name: Apache v2 License
@@ -9,8 +9,31 @@ paths:
/circuits/circuit-terminations/:
get:
operationId: circuits_circuit_terminations_list
- description: Extend DRF's ModelViewSet to support bulk update and delete functions.
+ description: |-
+ Base class to 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:
@@ -40,12 +63,158 @@ paths:
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
@@ -127,13 +296,54 @@ paths:
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
- description: Site (slug)
+ format: uuid
+ description: Site (slug or ID)
explode: true
style: form
- in: query
@@ -142,7 +352,8 @@ paths:
type: array
items:
type: string
- description: Site (slug)
+ format: uuid
+ description: Site (slug or ID)
explode: true
style: form
- in: query
@@ -153,7 +364,7 @@ paths:
type: string
format: uuid
nullable: true
- description: Site (ID)
+ description: Site (ID) (deprecated, use "site" filter instead)
explode: true
style: form
- in: query
@@ -164,7 +375,7 @@ paths:
type: string
format: uuid
nullable: true
- description: Site (ID)
+ description: Site (ID) (deprecated, use "site" filter instead)
explode: true
style: form
- in: query
@@ -351,20 +562,17 @@ paths:
description: ''
post:
operationId: circuits_circuit_terminations_create
- description: Extend DRF's ModelViewSet to support bulk update and delete functions.
+ description: |-
+ Base class to 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/WritableCircuitTermination'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableCircuitTermination'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableCircuitTermination'
+ $ref: '#/components/schemas/WritableCircuitTerminationRequest'
required: true
security:
- cookieAuth: []
@@ -378,20 +586,19 @@ paths:
description: ''
put:
operationId: circuits_circuit_terminations_bulk_update
- description: Extend DRF's ModelViewSet to support bulk update and delete functions.
+ description: |-
+ Base class to 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/WritableCircuitTermination'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableCircuitTermination'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableCircuitTermination'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableCircuitTerminationRequest'
required: true
security:
- cookieAuth: []
@@ -401,24 +608,26 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/CircuitTermination'
+ type: array
+ items:
+ $ref: '#/components/schemas/CircuitTermination'
description: ''
patch:
operationId: circuits_circuit_terminations_bulk_partial_update
- description: Extend DRF's ModelViewSet to support bulk update and delete functions.
+ description: |-
+ Base class to 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/PatchedWritableCircuitTermination'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableCircuitTermination'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableCircuitTermination'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableCircuitTerminationRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -427,11 +636,16 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/CircuitTermination'
+ type: array
+ items:
+ $ref: '#/components/schemas/CircuitTermination'
description: ''
delete:
operationId: circuits_circuit_terminations_bulk_destroy
- description: Extend DRF's ModelViewSet to support bulk update and delete functions.
+ description: |-
+ Base class to 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:
@@ -440,10 +654,21 @@ paths:
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: Extend DRF's ModelViewSet to support bulk update and delete functions.
+ description: |-
+ Base class to 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
@@ -466,7 +691,10 @@ paths:
description: ''
put:
operationId: circuits_circuit_terminations_update
- description: Extend DRF's ModelViewSet to support bulk update and delete functions.
+ description: |-
+ Base class to 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
@@ -481,13 +709,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableCircuitTermination'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableCircuitTermination'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableCircuitTermination'
+ $ref: '#/components/schemas/WritableCircuitTerminationRequest'
required: true
security:
- cookieAuth: []
@@ -501,7 +723,10 @@ paths:
description: ''
patch:
operationId: circuits_circuit_terminations_partial_update
- description: Extend DRF's ModelViewSet to support bulk update and delete functions.
+ description: |-
+ Base class to 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
@@ -516,13 +741,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableCircuitTermination'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableCircuitTermination'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableCircuitTermination'
+ $ref: '#/components/schemas/PatchedWritableCircuitTerminationRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -535,7 +754,10 @@ paths:
description: ''
delete:
operationId: circuits_circuit_terminations_destroy
- description: Extend DRF's ModelViewSet to support bulk update and delete functions.
+ description: |-
+ Base class to 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
@@ -552,6 +774,71 @@ paths:
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
@@ -580,8 +867,10 @@ paths:
/circuits/circuit-types/:
get:
operationId: circuits_circuit_types_list
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -994,21 +1283,17 @@ paths:
description: ''
post:
operationId: circuits_circuit_types_create
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/CircuitType'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/CircuitType'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/CircuitType'
+ $ref: '#/components/schemas/CircuitTypeRequest'
required: true
security:
- cookieAuth: []
@@ -1022,21 +1307,19 @@ paths:
description: ''
put:
operationId: circuits_circuit_types_bulk_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/CircuitType'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/CircuitType'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/CircuitType'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableCircuitTypeRequest'
required: true
security:
- cookieAuth: []
@@ -1046,25 +1329,26 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/CircuitType'
+ type: array
+ items:
+ $ref: '#/components/schemas/CircuitType'
description: ''
patch:
operationId: circuits_circuit_types_bulk_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/PatchedCircuitType'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedCircuitType'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedCircuitType'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableCircuitTypeRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -1073,12 +1357,16 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/CircuitType'
+ type: array
+ items:
+ $ref: '#/components/schemas/CircuitType'
description: ''
delete:
operationId: circuits_circuit_types_bulk_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -1087,11 +1375,21 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -1114,8 +1412,10 @@ paths:
description: ''
put:
operationId: circuits_circuit_types_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -1130,13 +1430,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/CircuitType'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/CircuitType'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/CircuitType'
+ $ref: '#/components/schemas/CircuitTypeRequest'
required: true
security:
- cookieAuth: []
@@ -1150,8 +1444,10 @@ paths:
description: ''
patch:
operationId: circuits_circuit_types_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -1166,13 +1462,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedCircuitType'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedCircuitType'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedCircuitType'
+ $ref: '#/components/schemas/PatchedCircuitTypeRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -1185,8 +1475,10 @@ paths:
description: ''
delete:
operationId: circuits_circuit_types_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -1203,6 +1495,71 @@ paths:
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
@@ -1585,6 +1942,24 @@ paths:
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
@@ -1772,7 +2147,8 @@ paths:
type: array
items:
type: string
- description: Tenant (slug)
+ format: uuid
+ description: Tenant (slug or ID)
explode: true
style: form
- in: query
@@ -1781,7 +2157,8 @@ paths:
type: array
items:
type: string
- description: Tenant (slug)
+ format: uuid
+ description: Tenant (slug or ID)
explode: true
style: form
- in: query
@@ -1832,7 +2209,7 @@ paths:
type: string
format: uuid
nullable: true
- description: Tenant (ID)
+ description: Tenant (ID) (deprecated, use "tenant" filter instead)
explode: true
style: form
- in: query
@@ -1843,7 +2220,7 @@ paths:
type: string
format: uuid
nullable: true
- description: Tenant (ID)
+ description: Tenant (ID) (deprecated, use "tenant" filter instead)
explode: true
style: form
- in: query
@@ -1906,13 +2283,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableCircuit'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableCircuit'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableCircuit'
+ $ref: '#/components/schemas/WritableCircuitRequest'
required: true
security:
- cookieAuth: []
@@ -1934,13 +2305,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableCircuit'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableCircuit'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableCircuit'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableCircuitRequest'
required: true
security:
- cookieAuth: []
@@ -1950,7 +2317,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/Circuit'
+ type: array
+ items:
+ $ref: '#/components/schemas/Circuit'
description: ''
patch:
operationId: circuits_circuits_bulk_partial_update
@@ -1962,13 +2331,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableCircuit'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableCircuit'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableCircuit'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableCircuitRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -1977,7 +2343,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/Circuit'
+ type: array
+ items:
+ $ref: '#/components/schemas/Circuit'
description: ''
delete:
operationId: circuits_circuits_bulk_destroy
@@ -1991,6 +2359,14 @@ paths:
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
@@ -2034,13 +2410,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableCircuit'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableCircuit'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableCircuit'
+ $ref: '#/components/schemas/WritableCircuitRequest'
required: true
security:
- cookieAuth: []
@@ -2070,13 +2440,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableCircuit'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableCircuit'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableCircuit'
+ $ref: '#/components/schemas/PatchedWritableCircuitRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -2107,11 +2471,78 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -2578,21 +3009,17 @@ paths:
description: ''
post:
operationId: circuits_provider_networks_create
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritableProviderNetwork'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableProviderNetwork'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableProviderNetwork'
+ $ref: '#/components/schemas/WritableProviderNetworkRequest'
required: true
security:
- cookieAuth: []
@@ -2606,21 +3033,19 @@ paths:
description: ''
put:
operationId: circuits_provider_networks_bulk_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritableProviderNetwork'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableProviderNetwork'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableProviderNetwork'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableProviderNetworkRequest'
required: true
security:
- cookieAuth: []
@@ -2630,25 +3055,26 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/ProviderNetwork'
+ type: array
+ items:
+ $ref: '#/components/schemas/ProviderNetwork'
description: ''
patch:
operationId: circuits_provider_networks_bulk_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/PatchedWritableProviderNetwork'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableProviderNetwork'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableProviderNetwork'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableProviderNetworkRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -2657,12 +3083,16 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/ProviderNetwork'
+ type: array
+ items:
+ $ref: '#/components/schemas/ProviderNetwork'
description: ''
delete:
operationId: circuits_provider_networks_bulk_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -2671,11 +3101,21 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -2698,8 +3138,10 @@ paths:
description: ''
put:
operationId: circuits_provider_networks_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -2714,13 +3156,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableProviderNetwork'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableProviderNetwork'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableProviderNetwork'
+ $ref: '#/components/schemas/WritableProviderNetworkRequest'
required: true
security:
- cookieAuth: []
@@ -2734,8 +3170,10 @@ paths:
description: ''
patch:
operationId: circuits_provider_networks_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -2750,13 +3188,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableProviderNetwork'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableProviderNetwork'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableProviderNetwork'
+ $ref: '#/components/schemas/PatchedWritableProviderNetworkRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -2769,8 +3201,10 @@ paths:
description: ''
delete:
operationId: circuits_provider_networks_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -2787,11 +3221,78 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -3115,6 +3616,24 @@ paths:
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:
@@ -3458,21 +3977,17 @@ paths:
description: ''
post:
operationId: circuits_providers_create
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/Provider'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/Provider'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/Provider'
+ $ref: '#/components/schemas/ProviderRequest'
required: true
security:
- cookieAuth: []
@@ -3486,21 +4001,19 @@ paths:
description: ''
put:
operationId: circuits_providers_bulk_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/Provider'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/Provider'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/Provider'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableProviderRequest'
required: true
security:
- cookieAuth: []
@@ -3510,25 +4023,26 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/Provider'
+ type: array
+ items:
+ $ref: '#/components/schemas/Provider'
description: ''
patch:
operationId: circuits_providers_bulk_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/PatchedProvider'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedProvider'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedProvider'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableProviderRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -3537,12 +4051,16 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/Provider'
+ type: array
+ items:
+ $ref: '#/components/schemas/Provider'
description: ''
delete:
operationId: circuits_providers_bulk_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -3551,11 +4069,21 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -3578,8 +4106,10 @@ paths:
description: ''
put:
operationId: circuits_providers_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -3594,13 +4124,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Provider'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/Provider'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/Provider'
+ $ref: '#/components/schemas/ProviderRequest'
required: true
security:
- cookieAuth: []
@@ -3614,8 +4138,10 @@ paths:
description: ''
patch:
operationId: circuits_providers_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -3630,13 +4156,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedProvider'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedProvider'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedProvider'
+ $ref: '#/components/schemas/PatchedProviderRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -3649,8 +4169,10 @@ paths:
description: ''
delete:
operationId: circuits_providers_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -3667,6 +4189,71 @@ paths:
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
@@ -3681,6 +4268,46 @@ paths:
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:
@@ -3689,6 +4316,62 @@ paths:
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:
@@ -4068,6 +4751,25 @@ paths:
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:
@@ -4140,6 +4842,290 @@ paths:
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:
@@ -4178,13 +5164,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableCable'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableCable'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableCable'
+ $ref: '#/components/schemas/WritableCableRequest'
required: true
security:
- cookieAuth: []
@@ -4206,13 +5186,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableCable'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableCable'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableCable'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableCableRequest'
required: true
security:
- cookieAuth: []
@@ -4222,7 +5198,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/Cable'
+ type: array
+ items:
+ $ref: '#/components/schemas/Cable'
description: ''
patch:
operationId: dcim_cables_bulk_partial_update
@@ -4234,13 +5212,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableCable'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableCable'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableCable'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableCableRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -4249,7 +5224,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/Cable'
+ type: array
+ items:
+ $ref: '#/components/schemas/Cable'
description: ''
delete:
operationId: dcim_cables_bulk_destroy
@@ -4263,6 +5240,14 @@ paths:
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
@@ -4306,13 +5291,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableCable'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableCable'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableCable'
+ $ref: '#/components/schemas/WritableCableRequest'
required: true
security:
- cookieAuth: []
@@ -4342,13 +5321,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableCable'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableCable'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableCable'
+ $ref: '#/components/schemas/PatchedWritableCableRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -4379,6 +5352,71 @@ paths:
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
@@ -4439,173 +5477,6 @@ paths:
description: Device (ID)
explode: true
style: form
- - name: limit
- required: false
- in: query
- description: Number of results to return per page.
- schema:
- type: integer
- - in: query
- name: name
- schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: name__ic
- schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: name__ie
- schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: name__iew
- schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: name__ire
- schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: name__isw
- schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: name__n
- schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: name__nic
- schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: name__nie
- schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: name__niew
- schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: name__nire
- schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: name__nisw
- schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: name__nre
- schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: name__re
- schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - name: offset
- required: false
- in: query
- description: The initial index from which to return the results.
- schema:
- type: integer
- - in: query
- name: site
- schema:
- type: string
- description: Site (slug)
- tags:
- - dcim
- security:
- - cookieAuth: []
- - tokenAuth: []
- responses:
- '200':
- content:
- application/json; version=1.3:
- schema:
- $ref: '#/components/schemas/PaginatedConsolePortList'
- description: ''
- /dcim/console-port-templates/:
- get:
- operationId: dcim_console_port_templates_list
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
- parameters:
- - in: query
- name: devicetype_id
- schema:
- type: array
- items:
- type: string
- format: uuid
- description: Device type (ID)
- explode: true
- style: form
- - in: query
- name: devicetype_id__n
- schema:
- type: array
- items:
- type: string
- format: uuid
- description: Device type (ID)
- explode: true
- style: form
- in: query
name: id
schema:
@@ -4856,6 +5727,601 @@ paths:
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:
@@ -4883,21 +6349,17 @@ paths:
description: ''
post:
operationId: dcim_console_port_templates_create
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritableConsolePortTemplate'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableConsolePortTemplate'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableConsolePortTemplate'
+ $ref: '#/components/schemas/WritableConsolePortTemplateRequest'
required: true
security:
- cookieAuth: []
@@ -4911,21 +6373,19 @@ paths:
description: ''
put:
operationId: dcim_console_port_templates_bulk_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritableConsolePortTemplate'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableConsolePortTemplate'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableConsolePortTemplate'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableConsolePortTemplateRequest'
required: true
security:
- cookieAuth: []
@@ -4935,25 +6395,26 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/ConsolePortTemplate'
+ type: array
+ items:
+ $ref: '#/components/schemas/ConsolePortTemplate'
description: ''
patch:
operationId: dcim_console_port_templates_bulk_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/PatchedWritableConsolePortTemplate'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableConsolePortTemplate'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableConsolePortTemplate'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableConsolePortTemplateRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -4962,12 +6423,16 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/ConsolePortTemplate'
+ type: array
+ items:
+ $ref: '#/components/schemas/ConsolePortTemplate'
description: ''
delete:
operationId: dcim_console_port_templates_bulk_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -4976,11 +6441,21 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -5003,8 +6478,10 @@ paths:
description: ''
put:
operationId: dcim_console_port_templates_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -5019,13 +6496,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableConsolePortTemplate'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableConsolePortTemplate'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableConsolePortTemplate'
+ $ref: '#/components/schemas/WritableConsolePortTemplateRequest'
required: true
security:
- cookieAuth: []
@@ -5039,8 +6510,10 @@ paths:
description: ''
patch:
operationId: dcim_console_port_templates_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -5055,13 +6528,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableConsolePortTemplate'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableConsolePortTemplate'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableConsolePortTemplate'
+ $ref: '#/components/schemas/PatchedWritableConsolePortTemplateRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -5074,8 +6541,10 @@ paths:
description: ''
delete:
operationId: dcim_console_port_templates_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -5092,12 +6561,99 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -5385,6 +6941,118 @@ paths:
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
@@ -5640,21 +7308,17 @@ paths:
description: ''
post:
operationId: dcim_console_ports_create
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritableConsolePort'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableConsolePort'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableConsolePort'
+ $ref: '#/components/schemas/WritableConsolePortRequest'
required: true
security:
- cookieAuth: []
@@ -5668,21 +7332,19 @@ paths:
description: ''
put:
operationId: dcim_console_ports_bulk_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritableConsolePort'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableConsolePort'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableConsolePort'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableConsolePortRequest'
required: true
security:
- cookieAuth: []
@@ -5692,25 +7354,26 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/ConsolePort'
+ type: array
+ items:
+ $ref: '#/components/schemas/ConsolePort'
description: ''
patch:
operationId: dcim_console_ports_bulk_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/PatchedWritableConsolePort'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableConsolePort'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableConsolePort'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableConsolePortRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -5719,12 +7382,16 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/ConsolePort'
+ type: array
+ items:
+ $ref: '#/components/schemas/ConsolePort'
description: ''
delete:
operationId: dcim_console_ports_bulk_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -5733,11 +7400,21 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -5760,8 +7437,10 @@ paths:
description: ''
put:
operationId: dcim_console_ports_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -5776,13 +7455,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableConsolePort'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableConsolePort'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableConsolePort'
+ $ref: '#/components/schemas/WritableConsolePortRequest'
required: true
security:
- cookieAuth: []
@@ -5796,8 +7469,10 @@ paths:
description: ''
patch:
operationId: dcim_console_ports_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -5812,13 +7487,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableConsolePort'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableConsolePort'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableConsolePort'
+ $ref: '#/components/schemas/PatchedWritableConsolePortRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -5831,8 +7500,10 @@ paths:
description: ''
delete:
operationId: dcim_console_ports_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -5849,6 +7520,71 @@ paths:
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
@@ -5877,9 +7613,157 @@ paths:
/dcim/console-server-port-templates/:
get:
operationId: dcim_console_server_port_templates_list
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -5907,6 +7791,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -5916,6 +7801,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -5925,6 +7811,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -5934,6 +7821,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -5943,6 +7831,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -5952,6 +7841,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -5961,6 +7851,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -5970,6 +7861,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -5979,6 +7871,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -5988,6 +7881,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -5997,6 +7891,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -6006,6 +7901,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -6015,6 +7911,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -6024,6 +7921,133 @@ paths:
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
@@ -6038,6 +8062,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -6046,6 +8071,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -6054,6 +8080,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -6062,6 +8089,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -6070,6 +8098,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -6078,6 +8107,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -6086,6 +8116,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -6094,6 +8125,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -6102,6 +8134,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -6110,6 +8143,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -6118,6 +8152,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -6126,6 +8161,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -6134,6 +8170,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -6142,6 +8179,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- name: offset
@@ -6177,21 +8215,17 @@ paths:
description: ''
post:
operationId: dcim_console_server_port_templates_create
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritableConsoleServerPortTemplate'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableConsoleServerPortTemplate'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableConsoleServerPortTemplate'
+ $ref: '#/components/schemas/WritableConsoleServerPortTemplateRequest'
required: true
security:
- cookieAuth: []
@@ -6205,21 +8239,19 @@ paths:
description: ''
put:
operationId: dcim_console_server_port_templates_bulk_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritableConsoleServerPortTemplate'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableConsoleServerPortTemplate'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableConsoleServerPortTemplate'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableConsoleServerPortTemplateRequest'
required: true
security:
- cookieAuth: []
@@ -6229,25 +8261,26 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/ConsoleServerPortTemplate'
+ type: array
+ items:
+ $ref: '#/components/schemas/ConsoleServerPortTemplate'
description: ''
patch:
operationId: dcim_console_server_port_templates_bulk_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/PatchedWritableConsoleServerPortTemplate'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableConsoleServerPortTemplate'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableConsoleServerPortTemplate'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableConsoleServerPortTemplateRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -6256,12 +8289,16 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/ConsoleServerPortTemplate'
+ type: array
+ items:
+ $ref: '#/components/schemas/ConsoleServerPortTemplate'
description: ''
delete:
operationId: dcim_console_server_port_templates_bulk_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -6270,11 +8307,21 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -6297,8 +8344,10 @@ paths:
description: ''
put:
operationId: dcim_console_server_port_templates_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -6313,13 +8362,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableConsoleServerPortTemplate'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableConsoleServerPortTemplate'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableConsoleServerPortTemplate'
+ $ref: '#/components/schemas/WritableConsoleServerPortTemplateRequest'
required: true
security:
- cookieAuth: []
@@ -6333,8 +8376,10 @@ paths:
description: ''
patch:
operationId: dcim_console_server_port_templates_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -6349,13 +8394,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableConsoleServerPortTemplate'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableConsoleServerPortTemplate'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableConsoleServerPortTemplate'
+ $ref: '#/components/schemas/PatchedWritableConsoleServerPortTemplateRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -6368,8 +8407,10 @@ paths:
description: ''
delete:
operationId: dcim_console_server_port_templates_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -6386,12 +8427,99 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -6679,6 +8807,118 @@ paths:
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
@@ -6934,21 +9174,17 @@ paths:
description: ''
post:
operationId: dcim_console_server_ports_create
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritableConsoleServerPort'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableConsoleServerPort'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableConsoleServerPort'
+ $ref: '#/components/schemas/WritableConsoleServerPortRequest'
required: true
security:
- cookieAuth: []
@@ -6962,21 +9198,19 @@ paths:
description: ''
put:
operationId: dcim_console_server_ports_bulk_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritableConsoleServerPort'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableConsoleServerPort'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableConsoleServerPort'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableConsoleServerPortRequest'
required: true
security:
- cookieAuth: []
@@ -6986,25 +9220,26 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/ConsoleServerPort'
+ type: array
+ items:
+ $ref: '#/components/schemas/ConsoleServerPort'
description: ''
patch:
operationId: dcim_console_server_ports_bulk_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/PatchedWritableConsoleServerPort'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableConsoleServerPort'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableConsoleServerPort'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableConsoleServerPortRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -7013,12 +9248,16 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/ConsoleServerPort'
+ type: array
+ items:
+ $ref: '#/components/schemas/ConsoleServerPort'
description: ''
delete:
operationId: dcim_console_server_ports_bulk_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -7027,11 +9266,21 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -7054,8 +9303,10 @@ paths:
description: ''
put:
operationId: dcim_console_server_ports_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -7070,13 +9321,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableConsoleServerPort'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableConsoleServerPort'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableConsoleServerPort'
+ $ref: '#/components/schemas/WritableConsoleServerPortRequest'
required: true
security:
- cookieAuth: []
@@ -7090,8 +9335,10 @@ paths:
description: ''
patch:
operationId: dcim_console_server_ports_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -7106,13 +9353,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableConsoleServerPort'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableConsoleServerPort'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableConsoleServerPort'
+ $ref: '#/components/schemas/PatchedWritableConsoleServerPortRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -7125,8 +9366,10 @@ paths:
description: ''
delete:
operationId: dcim_console_server_ports_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -7143,6 +9386,71 @@ paths:
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
@@ -7171,9 +9479,157 @@ paths:
/dcim/device-bay-templates/:
get:
operationId: dcim_device_bay_templates_list
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -7201,6 +9657,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -7210,6 +9667,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -7219,6 +9677,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -7228,6 +9687,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -7237,6 +9697,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -7246,6 +9707,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -7255,6 +9717,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -7264,6 +9727,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -7273,6 +9737,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -7282,6 +9747,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -7291,6 +9757,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -7300,6 +9767,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -7309,6 +9777,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -7318,6 +9787,133 @@ paths:
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
@@ -7332,6 +9928,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -7340,6 +9937,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -7348,6 +9946,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -7356,6 +9955,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -7364,6 +9964,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -7372,6 +9973,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -7380,6 +9982,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -7388,6 +9991,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -7396,6 +10000,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -7404,6 +10009,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -7412,6 +10018,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -7420,6 +10027,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -7428,6 +10036,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -7436,6 +10045,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- name: offset
@@ -7463,21 +10073,17 @@ paths:
description: ''
post:
operationId: dcim_device_bay_templates_create
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritableDeviceBayTemplate'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableDeviceBayTemplate'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableDeviceBayTemplate'
+ $ref: '#/components/schemas/WritableDeviceBayTemplateRequest'
required: true
security:
- cookieAuth: []
@@ -7491,21 +10097,19 @@ paths:
description: ''
put:
operationId: dcim_device_bay_templates_bulk_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritableDeviceBayTemplate'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableDeviceBayTemplate'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableDeviceBayTemplate'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableDeviceBayTemplateRequest'
required: true
security:
- cookieAuth: []
@@ -7515,25 +10119,26 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/DeviceBayTemplate'
+ type: array
+ items:
+ $ref: '#/components/schemas/DeviceBayTemplate'
description: ''
patch:
operationId: dcim_device_bay_templates_bulk_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/PatchedWritableDeviceBayTemplate'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableDeviceBayTemplate'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableDeviceBayTemplate'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableDeviceBayTemplateRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -7542,12 +10147,16 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/DeviceBayTemplate'
+ type: array
+ items:
+ $ref: '#/components/schemas/DeviceBayTemplate'
description: ''
delete:
operationId: dcim_device_bay_templates_bulk_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -7556,11 +10165,21 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -7583,8 +10202,10 @@ paths:
description: ''
put:
operationId: dcim_device_bay_templates_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -7599,13 +10220,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableDeviceBayTemplate'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableDeviceBayTemplate'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableDeviceBayTemplate'
+ $ref: '#/components/schemas/WritableDeviceBayTemplateRequest'
required: true
security:
- cookieAuth: []
@@ -7619,8 +10234,10 @@ paths:
description: ''
patch:
operationId: dcim_device_bay_templates_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -7635,13 +10252,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableDeviceBayTemplate'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableDeviceBayTemplate'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableDeviceBayTemplate'
+ $ref: '#/components/schemas/PatchedWritableDeviceBayTemplateRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -7654,8 +10265,10 @@ paths:
description: ''
delete:
operationId: dcim_device_bay_templates_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -7672,11 +10285,78 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -7956,6 +10636,138 @@ paths:
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
@@ -8193,21 +11005,17 @@ paths:
description: ''
post:
operationId: dcim_device_bays_create
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritableDeviceBay'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableDeviceBay'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableDeviceBay'
+ $ref: '#/components/schemas/WritableDeviceBayRequest'
required: true
security:
- cookieAuth: []
@@ -8221,21 +11029,19 @@ paths:
description: ''
put:
operationId: dcim_device_bays_bulk_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritableDeviceBay'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableDeviceBay'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableDeviceBay'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableDeviceBayRequest'
required: true
security:
- cookieAuth: []
@@ -8245,25 +11051,26 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/DeviceBay'
+ type: array
+ items:
+ $ref: '#/components/schemas/DeviceBay'
description: ''
patch:
operationId: dcim_device_bays_bulk_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/PatchedWritableDeviceBay'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableDeviceBay'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableDeviceBay'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableDeviceBayRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -8272,12 +11079,16 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/DeviceBay'
+ type: array
+ items:
+ $ref: '#/components/schemas/DeviceBay'
description: ''
delete:
operationId: dcim_device_bays_bulk_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -8286,11 +11097,21 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -8313,8 +11134,10 @@ paths:
description: ''
put:
operationId: dcim_device_bays_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -8329,13 +11152,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableDeviceBay'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableDeviceBay'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableDeviceBay'
+ $ref: '#/components/schemas/WritableDeviceBayRequest'
required: true
security:
- cookieAuth: []
@@ -8349,8 +11166,10 @@ paths:
description: ''
patch:
operationId: dcim_device_bays_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -8365,13 +11184,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableDeviceBay'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableDeviceBay'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableDeviceBay'
+ $ref: '#/components/schemas/PatchedWritableDeviceBayRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -8384,8 +11197,10 @@ paths:
description: ''
delete:
operationId: dcim_device_bays_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -8402,11 +11217,818 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -8535,6 +12157,146 @@ paths:
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:
@@ -8917,6 +12679,24 @@ paths:
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:
@@ -8935,21 +12715,17 @@ paths:
description: ''
post:
operationId: dcim_device_roles_create
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/DeviceRole'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/DeviceRole'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/DeviceRole'
+ $ref: '#/components/schemas/DeviceRoleRequest'
required: true
security:
- cookieAuth: []
@@ -8963,21 +12739,19 @@ paths:
description: ''
put:
operationId: dcim_device_roles_bulk_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/DeviceRole'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/DeviceRole'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/DeviceRole'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableDeviceRoleRequest'
required: true
security:
- cookieAuth: []
@@ -8987,25 +12761,26 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/DeviceRole'
+ type: array
+ items:
+ $ref: '#/components/schemas/DeviceRole'
description: ''
patch:
operationId: dcim_device_roles_bulk_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/PatchedDeviceRole'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedDeviceRole'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedDeviceRole'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableDeviceRoleRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -9014,12 +12789,16 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/DeviceRole'
+ type: array
+ items:
+ $ref: '#/components/schemas/DeviceRole'
description: ''
delete:
operationId: dcim_device_roles_bulk_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -9028,11 +12807,21 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -9055,8 +12844,10 @@ paths:
description: ''
put:
operationId: dcim_device_roles_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -9071,13 +12862,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/DeviceRole'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/DeviceRole'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/DeviceRole'
+ $ref: '#/components/schemas/DeviceRoleRequest'
required: true
security:
- cookieAuth: []
@@ -9091,8 +12876,10 @@ paths:
description: ''
patch:
operationId: dcim_device_roles_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -9107,13 +12894,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedDeviceRole'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedDeviceRole'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedDeviceRole'
+ $ref: '#/components/schemas/PatchedDeviceRoleRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -9126,8 +12907,10 @@ paths:
description: ''
delete:
operationId: dcim_device_roles_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -9144,17 +12927,236 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -9175,11 +13177,96 @@ paths:
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:
@@ -9306,6 +13393,44 @@ paths:
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:
@@ -9609,11 +13734,51 @@ paths:
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:
@@ -9624,6 +13789,26 @@ paths:
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:
@@ -9828,21 +14013,17 @@ paths:
description: ''
post:
operationId: dcim_device_types_create
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritableDeviceType'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableDeviceType'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableDeviceType'
+ $ref: '#/components/schemas/WritableDeviceTypeRequest'
required: true
security:
- cookieAuth: []
@@ -9856,21 +14037,19 @@ paths:
description: ''
put:
operationId: dcim_device_types_bulk_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritableDeviceType'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableDeviceType'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableDeviceType'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableDeviceTypeRequest'
required: true
security:
- cookieAuth: []
@@ -9880,25 +14059,26 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/DeviceType'
+ type: array
+ items:
+ $ref: '#/components/schemas/DeviceType'
description: ''
patch:
operationId: dcim_device_types_bulk_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/PatchedWritableDeviceType'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableDeviceType'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableDeviceType'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableDeviceTypeRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -9907,12 +14087,16 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/DeviceType'
+ type: array
+ items:
+ $ref: '#/components/schemas/DeviceType'
description: ''
delete:
operationId: dcim_device_types_bulk_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -9921,11 +14105,21 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -9948,8 +14142,10 @@ paths:
description: ''
put:
operationId: dcim_device_types_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -9964,13 +14160,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableDeviceType'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableDeviceType'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableDeviceType'
+ $ref: '#/components/schemas/WritableDeviceTypeRequest'
required: true
security:
- cookieAuth: []
@@ -9984,8 +14174,10 @@ paths:
description: ''
patch:
operationId: dcim_device_types_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -10000,13 +14192,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableDeviceType'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableDeviceType'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableDeviceType'
+ $ref: '#/components/schemas/PatchedWritableDeviceTypeRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -10019,8 +14205,10 @@ paths:
description: ''
delete:
operationId: dcim_device_types_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -10037,6 +14225,71 @@ paths:
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
@@ -10045,1307 +14298,1020 @@ paths:
Provides a get_queryset() method which deals with adding the config context
data annotation or not.
parameters:
- - in: query
- name: asset_tag
+ - name: asset_tag
+ required: false
+ in: query
+ description: asset_tag
schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: asset_tag__ic
+ type: string
+ - name: asset_tag__ic
+ required: false
+ in: query
+ description: asset_tag__ic
schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: asset_tag__ie
+ type: string
+ - name: asset_tag__ie
+ required: false
+ in: query
+ description: asset_tag__ie
schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: asset_tag__iew
+ type: string
+ - name: asset_tag__iew
+ required: false
+ in: query
+ description: asset_tag__iew
schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: asset_tag__ire
+ type: string
+ - name: asset_tag__ire
+ required: false
+ in: query
+ description: asset_tag__ire
schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: asset_tag__isw
+ type: string
+ - name: asset_tag__isw
+ required: false
+ in: query
+ description: asset_tag__isw
schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: asset_tag__n
+ type: string
+ - name: asset_tag__n
+ required: false
+ in: query
+ description: asset_tag__n
schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: asset_tag__nic
+ type: string
+ - name: asset_tag__nic
+ required: false
+ in: query
+ description: asset_tag__nic
schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: asset_tag__nie
+ type: string
+ - name: asset_tag__nie
+ required: false
+ in: query
+ description: asset_tag__nie
schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: asset_tag__niew
+ type: string
+ - name: asset_tag__niew
+ required: false
+ in: query
+ description: asset_tag__niew
schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: asset_tag__nire
+ type: string
+ - name: asset_tag__nire
+ required: false
+ in: query
+ description: asset_tag__nire
schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: asset_tag__nisw
+ type: string
+ - name: asset_tag__nisw
+ required: false
+ in: query
+ description: asset_tag__nisw
schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: asset_tag__nre
+ type: string
+ - name: asset_tag__nre
+ required: false
+ in: query
+ description: asset_tag__nre
schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: asset_tag__re
+ type: string
+ - name: asset_tag__re
+ required: false
+ in: query
+ description: asset_tag__re
schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: cluster_id
- schema:
- type: array
- items:
- type: string
- format: uuid
- nullable: true
+ type: string
+ - name: cluster_id
+ required: false
+ in: query
description: VM cluster (ID)
- explode: true
- style: form
- - in: query
- name: cluster_id__n
schema:
- type: array
- items:
- type: string
- format: uuid
- nullable: true
+ type: string
+ - name: cluster_id__n
+ required: false
+ in: query
description: VM cluster (ID)
- explode: true
- style: form
- - in: query
- name: console_ports
schema:
- type: boolean
+ type: string
+ - name: console_ports
+ required: false
+ in: query
description: Has console ports
- - in: query
- name: console_server_ports
schema:
- type: boolean
+ type: string
+ - name: console_server_ports
+ required: false
+ in: query
description: Has console server ports
- - in: query
- name: created
schema:
type: string
- format: date
- - in: query
- name: created__gte
+ - name: created
+ required: false
+ in: query
+ description: created
schema:
type: string
- format: date
- - in: query
- name: created__lte
+ - name: created__gte
+ required: false
+ in: query
+ description: created__gte
schema:
type: string
- format: date
- - in: query
- name: device_bays
+ - name: created__lte
+ required: false
+ in: query
+ description: created__lte
schema:
- type: boolean
+ type: string
+ - name: device_bays
+ required: false
+ in: query
description: Has device bays
- - in: query
- name: device_type_id
- schema:
- type: array
- items:
- type: string
- format: uuid
- description: Device type (ID)
- explode: true
- style: form
- - in: query
- name: device_type_id__n
- schema:
- type: array
- items:
- type: string
- format: uuid
- description: Device type (ID)
- explode: true
- style: form
- - in: query
- name: face
schema:
type: string
- title: Rack face
- - in: query
- name: face__n
+ - name: device_redundancy_group
+ required: false
+ in: query
+ description: Device Redundancy Groups (slug or ID)
schema:
type: string
- title: Rack face
- - in: query
- name: has_console_ports
+ - name: device_redundancy_group__n
+ required: false
+ in: query
+ description: Device Redundancy Groups (slug or ID)
schema:
- type: boolean
+ 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
- - in: query
- name: has_console_server_ports
schema:
- type: boolean
+ type: string
+ - name: has_console_server_ports
+ required: false
+ in: query
description: Has console server ports
- - in: query
- name: has_device_bays
schema:
- type: boolean
+ type: string
+ - name: has_device_bays
+ required: false
+ in: query
description: Has device bays
- - in: query
- name: has_front_ports
schema:
- type: boolean
+ type: string
+ - name: has_front_ports
+ required: false
+ in: query
description: Has front ports
- - in: query
- name: has_interfaces
schema:
- type: boolean
+ type: string
+ - name: has_interfaces
+ required: false
+ in: query
description: Has interfaces
- - in: query
- name: has_power_outlets
schema:
- type: boolean
+ type: string
+ - name: has_power_outlets
+ required: false
+ in: query
description: Has power outlets
- - in: query
- name: has_power_ports
schema:
- type: boolean
+ type: string
+ - name: has_power_ports
+ required: false
+ in: query
description: Has power ports
- - in: query
- name: has_primary_ip
schema:
- type: boolean
+ type: string
+ - name: has_primary_ip
+ required: false
+ in: query
description: Has a primary IP
- - in: query
- name: has_rear_ports
schema:
- type: boolean
+ type: string
+ - name: has_rear_ports
+ required: false
+ in: query
description: Has rear ports
- - in: query
- name: id
schema:
- type: array
- items:
- type: string
- format: uuid
- explode: true
- style: form
- - in: query
- name: id__ic
+ type: string
+ - name: id
+ required: false
+ in: query
+ description: id
schema:
- type: array
- items:
- type: string
- format: uuid
- explode: true
- style: form
- - in: query
- name: id__ie
+ type: string
+ - name: id__ic
+ required: false
+ in: query
+ description: id__ic
schema:
- type: array
- items:
- type: string
- format: uuid
- explode: true
- style: form
- - in: query
- name: id__iew
+ type: string
+ - name: id__ie
+ required: false
+ in: query
+ description: id__ie
schema:
- type: array
- items:
- type: string
- format: uuid
- explode: true
- style: form
- - in: query
- name: id__ire
+ type: string
+ - name: id__iew
+ required: false
+ in: query
+ description: id__iew
schema:
- type: array
- items:
- type: string
- format: uuid
- explode: true
- style: form
- - in: query
- name: id__isw
+ type: string
+ - name: id__ire
+ required: false
+ in: query
+ description: id__ire
schema:
- type: array
- items:
- type: string
- format: uuid
- explode: true
- style: form
- - in: query
- name: id__n
+ type: string
+ - name: id__isw
+ required: false
+ in: query
+ description: id__isw
schema:
- type: array
- items:
- type: string
- format: uuid
- explode: true
- style: form
- - in: query
- name: id__nic
+ type: string
+ - name: id__n
+ required: false
+ in: query
+ description: id__n
schema:
- type: array
- items:
- type: string
- format: uuid
- explode: true
- style: form
- - in: query
- name: id__nie
+ type: string
+ - name: id__nic
+ required: false
+ in: query
+ description: id__nic
schema:
- type: array
- items:
- type: string
- format: uuid
- explode: true
- style: form
- - in: query
- name: id__niew
+ type: string
+ - name: id__nie
+ required: false
+ in: query
+ description: id__nie
schema:
- type: array
- items:
- type: string
- format: uuid
- explode: true
- style: form
- - in: query
- name: id__nire
+ type: string
+ - name: id__niew
+ required: false
+ in: query
+ description: id__niew
schema:
- type: array
- items:
- type: string
- format: uuid
- explode: true
- style: form
- - in: query
- name: id__nisw
+ type: string
+ - name: id__nire
+ required: false
+ in: query
+ description: id__nire
schema:
- type: array
- items:
- type: string
- format: uuid
- explode: true
- style: form
- - in: query
- name: id__nre
+ type: string
+ - name: id__nisw
+ required: false
+ in: query
+ description: id__nisw
schema:
- type: array
- items:
- type: string
- format: uuid
- explode: true
- style: form
- - in: query
- name: id__re
+ type: string
+ - name: id__nre
+ required: false
+ in: query
+ description: id__nre
schema:
- type: array
- items:
- type: string
- format: uuid
- explode: true
- style: form
- - in: query
- name: interfaces
+ type: string
+ - name: id__re
+ required: false
+ in: query
+ description: id__re
schema:
- type: boolean
+ type: string
+ - name: interfaces
+ required: false
+ in: query
description: Has interfaces
- - in: query
- name: is_full_depth
schema:
- type: boolean
+ type: string
+ - name: is_full_depth
+ required: false
+ in: query
description: Is full depth
- - in: query
- name: is_virtual_chassis_member
schema:
- type: boolean
+ type: string
+ - name: is_virtual_chassis_member
+ required: false
+ in: query
description: Is a virtual chassis member
- - in: query
- name: last_updated
schema:
type: string
- format: date-time
- - in: query
- name: last_updated__gte
+ - name: last_updated
+ required: false
+ in: query
+ description: last_updated
schema:
type: string
- format: date-time
- - in: query
- name: last_updated__lte
+ - 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
- format: date-time
- name: limit
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- - in: query
- name: local_context_data
- schema:
- type: boolean
+ - name: local_context_data
+ required: false
+ in: query
description: Has local config context data
- - in: query
- name: local_context_schema
schema:
- type: array
- items:
- type: string
+ type: string
+ - name: local_context_schema
+ required: false
+ in: query
description: Schema (slug)
- explode: true
- style: form
- - in: query
- name: local_context_schema__n
schema:
- type: array
- items:
- type: string
+ type: string
+ - name: local_context_schema__n
+ required: false
+ in: query
description: Schema (slug)
- explode: true
- style: form
- - in: query
- name: local_context_schema_id
schema:
- type: array
- items:
- type: string
- format: uuid
- nullable: true
+ type: string
+ - name: local_context_schema_id
+ required: false
+ in: query
description: Schema (ID)
- explode: true
- style: form
- - in: query
- name: local_context_schema_id__n
schema:
- type: array
- items:
- type: string
- format: uuid
- nullable: true
+ type: string
+ - name: local_context_schema_id__n
+ required: false
+ in: query
description: Schema (ID)
- explode: true
- style: form
- - in: query
- name: mac_address
schema:
- type: array
- items:
- type: string
- nullable: true
+ 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
- explode: true
- style: form
- - in: query
- name: mac_address__ic
schema:
- type: array
- items:
- type: string
- nullable: true
+ type: string
+ - name: mac_address__ic
+ required: false
+ in: query
description: MAC address
- explode: true
- style: form
- - in: query
- name: mac_address__ie
schema:
- type: array
- items:
- type: string
- nullable: true
+ type: string
+ - name: mac_address__ie
+ required: false
+ in: query
description: MAC address
- explode: true
- style: form
- - in: query
- name: mac_address__iew
schema:
- type: array
- items:
- type: string
- nullable: true
+ type: string
+ - name: mac_address__iew
+ required: false
+ in: query
description: MAC address
- explode: true
- style: form
- - in: query
- name: mac_address__ire
schema:
- type: array
- items:
- type: string
- nullable: true
+ type: string
+ - name: mac_address__ire
+ required: false
+ in: query
description: MAC address
- explode: true
- style: form
- - in: query
- name: mac_address__isw
schema:
- type: array
- items:
- type: string
- nullable: true
+ type: string
+ - name: mac_address__isw
+ required: false
+ in: query
description: MAC address
- explode: true
- style: form
- - in: query
- name: mac_address__n
schema:
- type: array
- items:
- type: string
- nullable: true
+ type: string
+ - name: mac_address__n
+ required: false
+ in: query
description: MAC address
- explode: true
- style: form
- - in: query
- name: mac_address__nic
schema:
- type: array
- items:
- type: string
- nullable: true
+ type: string
+ - name: mac_address__nic
+ required: false
+ in: query
description: MAC address
- explode: true
- style: form
- - in: query
- name: mac_address__nie
schema:
- type: array
- items:
- type: string
- nullable: true
+ type: string
+ - name: mac_address__nie
+ required: false
+ in: query
description: MAC address
- explode: true
- style: form
- - in: query
- name: mac_address__niew
schema:
- type: array
- items:
- type: string
- nullable: true
+ type: string
+ - name: mac_address__niew
+ required: false
+ in: query
description: MAC address
- explode: true
- style: form
- - in: query
- name: mac_address__nire
schema:
- type: array
- items:
- type: string
- nullable: true
+ type: string
+ - name: mac_address__nire
+ required: false
+ in: query
description: MAC address
- explode: true
- style: form
- - in: query
- name: mac_address__nisw
schema:
- type: array
- items:
- type: string
- nullable: true
+ type: string
+ - name: mac_address__nisw
+ required: false
+ in: query
description: MAC address
- explode: true
- style: form
- - in: query
- name: mac_address__nre
schema:
- type: array
- items:
- type: string
- nullable: true
+ type: string
+ - name: mac_address__nre
+ required: false
+ in: query
description: MAC address
- explode: true
- style: form
- - in: query
- name: mac_address__re
schema:
- type: array
- items:
- type: string
- nullable: true
+ type: string
+ - name: mac_address__re
+ required: false
+ in: query
description: MAC address
- explode: true
- style: form
- - in: query
- name: manufacturer
schema:
- type: array
- items:
- type: string
+ type: string
+ - name: manufacturer
+ required: false
+ in: query
description: Manufacturer (slug)
- explode: true
- style: form
- - in: query
- name: manufacturer__n
schema:
- type: array
- items:
- type: string
+ type: string
+ - name: manufacturer__n
+ required: false
+ in: query
description: Manufacturer (slug)
- explode: true
- style: form
- - in: query
- name: manufacturer_id
schema:
- type: array
- items:
- type: string
- format: uuid
+ type: string
+ - name: manufacturer_id
+ required: false
+ in: query
description: Manufacturer (ID)
- explode: true
- style: form
- - in: query
- name: manufacturer_id__n
schema:
- type: array
- items:
- type: string
- format: uuid
+ type: string
+ - name: manufacturer_id__n
+ required: false
+ in: query
description: Manufacturer (ID)
- explode: true
- style: form
- - in: query
- name: model
schema:
- type: array
- items:
- type: string
+ type: string
+ - name: model
+ required: false
+ in: query
description: Device model (slug)
- explode: true
- style: form
- - in: query
- name: model__n
schema:
- type: array
- items:
- type: string
+ type: string
+ - name: model__n
+ required: false
+ in: query
description: Device model (slug)
- explode: true
- style: form
- - in: query
- name: name
schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: name__ic
+ type: string
+ - name: name
+ required: false
+ in: query
+ description: name
schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: name__ie
+ type: string
+ - name: name__ic
+ required: false
+ in: query
+ description: name__ic
schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: name__iew
+ type: string
+ - name: name__ie
+ required: false
+ in: query
+ description: name__ie
schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: name__ire
+ type: string
+ - name: name__iew
+ required: false
+ in: query
+ description: name__iew
schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: name__isw
+ type: string
+ - name: name__ire
+ required: false
+ in: query
+ description: name__ire
schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: name__n
+ type: string
+ - name: name__isw
+ required: false
+ in: query
+ description: name__isw
schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: name__nic
+ type: string
+ - name: name__n
+ required: false
+ in: query
+ description: name__n
schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: name__nie
+ type: string
+ - name: name__nic
+ required: false
+ in: query
+ description: name__nic
schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: name__niew
+ type: string
+ - name: name__nie
+ required: false
+ in: query
+ description: name__nie
schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: name__nire
+ type: string
+ - name: name__niew
+ required: false
+ in: query
+ description: name__niew
schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: name__nisw
+ type: string
+ - name: name__nire
+ required: false
+ in: query
+ description: name__nire
schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: name__nre
+ type: string
+ - name: name__nisw
+ required: false
+ in: query
+ description: name__nisw
schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: name__re
+ type: string
+ - name: name__nre
+ required: false
+ in: query
+ description: name__nre
schema:
- type: array
- items:
- type: string
- explode: true
- style: form
+ 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
- - in: query
- name: pass_through_ports
- schema:
- type: boolean
+ - name: pass_through_ports
+ required: false
+ in: query
description: Has pass-through ports
- - in: query
- name: platform
schema:
- type: array
- items:
- type: string
+ type: string
+ - name: platform
+ required: false
+ in: query
description: Platform (slug)
- explode: true
- style: form
- - in: query
- name: platform__n
schema:
- type: array
- items:
- type: string
+ type: string
+ - name: platform__n
+ required: false
+ in: query
description: Platform (slug)
- explode: true
- style: form
- - in: query
- name: platform_id
schema:
- type: array
- items:
- type: string
- format: uuid
- nullable: true
+ type: string
+ - name: platform_id
+ required: false
+ in: query
description: Platform (ID)
- explode: true
- style: form
- - in: query
- name: platform_id__n
schema:
- type: array
- items:
- type: string
- format: uuid
- nullable: true
+ type: string
+ - name: platform_id__n
+ required: false
+ in: query
description: Platform (ID)
- explode: true
- style: form
- - in: query
- name: position
schema:
- type: array
- items:
- type: integer
- explode: true
- style: form
- - in: query
- name: position__gt
+ type: string
+ - name: position
+ required: false
+ in: query
+ description: position
schema:
- type: array
- items:
- type: integer
- explode: true
- style: form
- - in: query
- name: position__gte
+ type: string
+ - name: position__gt
+ required: false
+ in: query
+ description: position__gt
schema:
- type: array
- items:
- type: integer
- explode: true
- style: form
- - in: query
- name: position__lt
+ type: string
+ - name: position__gte
+ required: false
+ in: query
+ description: position__gte
schema:
- type: array
- items:
- type: integer
- explode: true
- style: form
- - in: query
- name: position__lte
+ type: string
+ - name: position__lt
+ required: false
+ in: query
+ description: position__lt
schema:
- type: array
- items:
- type: integer
- explode: true
- style: form
- - in: query
- name: position__n
+ type: string
+ - name: position__lte
+ required: false
+ in: query
+ description: position__lte
schema:
- type: array
- items:
- type: integer
- explode: true
- style: form
- - in: query
- name: power_outlets
+ type: string
+ - name: position__n
+ required: false
+ in: query
+ description: position__n
schema:
- type: boolean
+ type: string
+ - name: power_outlets
+ required: false
+ in: query
description: Has power outlets
- - in: query
- name: power_ports
schema:
- type: boolean
+ type: string
+ - name: power_ports
+ required: false
+ in: query
description: Has power ports
- - in: query
- name: q
schema:
type: string
+ - name: q
+ required: false
+ in: query
description: Search
- - in: query
- name: rack_group_id
- schema:
- type: array
- items:
- type: string
- format: uuid
- description: Rack group (ID)
- explode: true
- style: form
- - in: query
- name: rack_group_id__n
- schema:
- type: array
- items:
- type: string
- format: uuid
- description: Rack group (ID)
- explode: true
- style: form
- - in: query
- name: rack_id
- schema:
- type: array
- items:
- type: string
- format: uuid
- description: Rack (ID)
- explode: true
- style: form
- - in: query
- name: rack_id__n
- schema:
- type: array
- items:
- type: string
- format: uuid
- description: Rack (ID)
- explode: true
- style: form
- - in: query
- name: region
- schema:
- type: array
- items:
- type: string
- format: uuid
- description: Region (slug)
- explode: true
- style: form
- - in: query
- name: region__n
- schema:
- type: array
- items:
- type: string
- format: uuid
- description: Region (slug)
- explode: true
- style: form
- - in: query
- name: region_id
- schema:
- type: array
- items:
- type: string
- format: uuid
- description: Region (ID)
- explode: true
- style: form
- - in: query
- name: region_id__n
- schema:
- type: array
- items:
- type: string
- format: uuid
- description: Region (ID)
- explode: true
- style: form
- - in: query
- name: role
- schema:
- type: array
- items:
- type: string
- description: Role (slug)
- explode: true
- style: form
- - in: query
- name: role__n
- schema:
- type: array
- items:
- type: string
- description: Role (slug)
- explode: true
- style: form
- - in: query
- name: role_id
- schema:
- type: array
- items:
- type: string
- format: uuid
- description: Role (ID)
- explode: true
- style: form
- - in: query
- name: role_id__n
- schema:
- type: array
- items:
- type: string
- format: uuid
- description: Role (ID)
- explode: true
- style: form
- - in: query
- name: secrets_group
- schema:
- type: array
- items:
- type: string
- description: Secrets group (slug)
- explode: true
- style: form
- - in: query
- name: secrets_group__n
- schema:
- type: array
- items:
- type: string
- description: Secrets group (slug)
- explode: true
- style: form
- - in: query
- name: secrets_group_id
- schema:
- type: array
- items:
- type: string
- format: uuid
- description: Secrets group (ID)
- explode: true
- style: form
- - in: query
- name: secrets_group_id__n
- schema:
- type: array
- items:
- type: string
- format: uuid
- description: Secrets group (ID)
- explode: true
- style: form
- - in: query
- name: serial
schema:
type: string
- - in: query
- name: site
+ - name: rack_group_id
+ required: false
+ in: query
+ description: Rack group (ID)
schema:
- type: array
- items:
- type: string
- description: Site name (slug)
- explode: true
- style: form
- - in: query
- name: site__n
+ type: string
+ - name: rack_group_id__n
+ required: false
+ in: query
+ description: Rack group (ID)
schema:
- type: array
- items:
- type: string
- description: Site name (slug)
- explode: true
- style: form
- - in: query
- name: site_id
+ type: string
+ - name: rack_id
+ required: false
+ in: query
+ description: Rack (ID)
schema:
- type: array
- items:
- type: string
- format: uuid
- description: Site (ID)
- explode: true
- style: form
- - in: query
- name: site_id__n
+ type: string
+ - name: rack_id__n
+ required: false
+ in: query
+ description: Rack (ID)
schema:
- type: array
- items:
- type: string
- format: uuid
- description: Site (ID)
- explode: true
- style: form
- - in: query
- name: status
+ type: string
+ - name: region
+ required: false
+ in: query
+ description: Region (slug or ID)
schema:
- type: array
- items:
- type: string
- format: uuid
- explode: true
- style: form
- - in: query
- name: status__n
+ type: string
+ - name: region__n
+ required: false
+ in: query
+ description: Region (slug or ID)
schema:
- type: array
- items:
- type: string
- format: uuid
- explode: true
- style: form
- - in: query
- name: tag
+ type: string
+ - name: region_id
+ required: false
+ in: query
+ description: Region (ID) (deprecated, use "region" filter instead)
schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: tag__n
+ type: string
+ - name: region_id__n
+ required: false
+ in: query
+ description: Region (ID) (deprecated, use "region" filter instead)
schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: tenant
+ type: string
+ - name: role
+ required: false
+ in: query
+ description: Role (slug)
schema:
- type: array
- items:
- type: string
- description: Tenant (slug)
- explode: true
- style: form
- - in: query
- name: tenant__n
+ type: string
+ - name: role__n
+ required: false
+ in: query
+ description: Role (slug)
schema:
- type: array
- items:
- type: string
- description: Tenant (slug)
- explode: true
- style: form
- - in: query
- name: tenant_group
+ type: string
+ - name: role_id
+ required: false
+ in: query
+ description: Role (ID)
schema:
- type: array
- items:
- type: string
- format: uuid
+ 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)
- explode: true
- style: form
- - in: query
- name: tenant_group__n
schema:
- type: array
- items:
- type: string
- format: uuid
+ type: string
+ - name: tenant_group__n
+ required: false
+ in: query
description: Tenant Group (slug)
- explode: true
- style: form
- - in: query
- name: tenant_group_id
schema:
- type: array
- items:
- type: string
- format: uuid
+ type: string
+ - name: tenant_group_id
+ required: false
+ in: query
description: Tenant Group (ID)
- explode: true
- style: form
- - in: query
- name: tenant_group_id__n
schema:
- type: array
- items:
- type: string
- format: uuid
+ type: string
+ - name: tenant_group_id__n
+ required: false
+ in: query
description: Tenant Group (ID)
- explode: true
- style: form
- - in: query
- name: tenant_id
schema:
- type: array
- items:
- type: string
- format: uuid
- nullable: true
- description: Tenant (ID)
- explode: true
- style: form
- - in: query
- name: tenant_id__n
+ type: string
+ - name: tenant_id
+ required: false
+ in: query
+ description: Tenant (ID) (deprecated, use "tenant" filter instead)
schema:
- type: array
- items:
- type: string
- format: uuid
- nullable: true
- description: Tenant (ID)
- explode: true
- style: form
- - in: query
- name: vc_position
+ type: string
+ - name: tenant_id__n
+ required: false
+ in: query
+ description: Tenant (ID) (deprecated, use "tenant" filter instead)
schema:
- type: array
- items:
- type: integer
- explode: true
- style: form
- - in: query
- name: vc_position__gt
+ type: string
+ - name: vc_position
+ required: false
+ in: query
+ description: vc_position
schema:
- type: array
- items:
- type: integer
- explode: true
- style: form
- - in: query
- name: vc_position__gte
+ type: string
+ - name: vc_position__gt
+ required: false
+ in: query
+ description: vc_position__gt
schema:
- type: array
- items:
- type: integer
- explode: true
- style: form
- - in: query
- name: vc_position__lt
+ type: string
+ - name: vc_position__gte
+ required: false
+ in: query
+ description: vc_position__gte
schema:
- type: array
- items:
- type: integer
- explode: true
- style: form
- - in: query
- name: vc_position__lte
+ type: string
+ - name: vc_position__lt
+ required: false
+ in: query
+ description: vc_position__lt
schema:
- type: array
- items:
- type: integer
- explode: true
- style: form
- - in: query
- name: vc_position__n
+ type: string
+ - name: vc_position__lte
+ required: false
+ in: query
+ description: vc_position__lte
schema:
- type: array
- items:
- type: integer
- explode: true
- style: form
- - in: query
- name: vc_priority
+ type: string
+ - name: vc_position__n
+ required: false
+ in: query
+ description: vc_position__n
schema:
- type: array
- items:
- type: integer
- explode: true
- style: form
- - in: query
- name: vc_priority__gt
+ type: string
+ - name: vc_priority
+ required: false
+ in: query
+ description: vc_priority
schema:
- type: array
- items:
- type: integer
- explode: true
- style: form
- - in: query
- name: vc_priority__gte
+ type: string
+ - name: vc_priority__gt
+ required: false
+ in: query
+ description: vc_priority__gt
schema:
- type: array
- items:
- type: integer
- explode: true
- style: form
- - in: query
- name: vc_priority__lt
+ type: string
+ - name: vc_priority__gte
+ required: false
+ in: query
+ description: vc_priority__gte
schema:
- type: array
- items:
- type: integer
- explode: true
- style: form
- - in: query
- name: vc_priority__lte
+ type: string
+ - name: vc_priority__lt
+ required: false
+ in: query
+ description: vc_priority__lt
schema:
- type: array
- items:
- type: integer
- explode: true
- style: form
- - in: query
- name: vc_priority__n
+ type: string
+ - name: vc_priority__lte
+ required: false
+ in: query
+ description: vc_priority__lte
schema:
- type: array
- items:
- type: integer
- explode: true
- style: form
- - in: query
- name: virtual_chassis_id
+ type: string
+ - name: vc_priority__n
+ required: false
+ in: query
+ description: vc_priority__n
schema:
- type: array
- items:
- type: string
- format: uuid
+ type: string
+ - name: virtual_chassis_id
+ required: false
+ in: query
description: Virtual chassis (ID)
- explode: true
- style: form
- - in: query
- name: virtual_chassis_id__n
schema:
- type: array
- items:
- type: string
- format: uuid
+ type: string
+ - name: virtual_chassis_id__n
+ required: false
+ in: query
description: Virtual chassis (ID)
- explode: true
- style: form
- - in: query
- name: virtual_chassis_member
schema:
- type: boolean
+ type: string
+ - name: virtual_chassis_member
+ required: false
+ in: query
description: Is a virtual chassis member
+ schema:
+ type: string
tags:
- dcim
security:
@@ -11370,13 +15336,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableDeviceWithConfigContext'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableDeviceWithConfigContext'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableDeviceWithConfigContext'
+ $ref: '#/components/schemas/WritableDeviceWithConfigContextRequest'
required: true
security:
- cookieAuth: []
@@ -11400,13 +15360,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableDeviceWithConfigContext'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableDeviceWithConfigContext'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableDeviceWithConfigContext'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableDeviceWithConfigContextRequest'
required: true
security:
- cookieAuth: []
@@ -11416,7 +15372,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/DeviceWithConfigContext'
+ type: array
+ items:
+ $ref: '#/components/schemas/DeviceWithConfigContext'
description: ''
patch:
operationId: dcim_devices_bulk_partial_update
@@ -11430,13 +15388,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableDeviceWithConfigContext'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableDeviceWithConfigContext'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableDeviceWithConfigContext'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableDeviceWithConfigContextRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -11445,7 +15400,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/DeviceWithConfigContext'
+ type: array
+ items:
+ $ref: '#/components/schemas/DeviceWithConfigContext'
description: ''
delete:
operationId: dcim_devices_bulk_destroy
@@ -11461,6 +15418,14 @@ paths:
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
@@ -11508,13 +15473,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableDeviceWithConfigContext'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableDeviceWithConfigContext'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableDeviceWithConfigContext'
+ $ref: '#/components/schemas/WritableDeviceWithConfigContextRequest'
required: true
security:
- cookieAuth: []
@@ -11546,13 +15505,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableDeviceWithConfigContext'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableDeviceWithConfigContext'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableDeviceWithConfigContext'
+ $ref: '#/components/schemas/PatchedWritableDeviceWithConfigContextRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -11614,12 +15567,225 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -11647,6 +15813,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -11656,6 +15823,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -11665,6 +15833,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -11674,6 +15843,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -11683,6 +15853,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -11692,6 +15863,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -11701,6 +15873,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -11710,6 +15883,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -11719,6 +15893,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -11728,6 +15903,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -11737,6 +15913,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -11746,6 +15923,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -11755,6 +15933,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -11764,6 +15943,133 @@ paths:
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
@@ -11778,6 +16084,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -11786,6 +16093,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -11794,6 +16102,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -11802,6 +16111,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -11810,6 +16120,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -11818,6 +16129,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -11826,6 +16138,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -11834,6 +16147,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -11842,6 +16156,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -11850,6 +16165,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -11858,6 +16174,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -11866,6 +16183,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -11874,6 +16192,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -11882,6 +16201,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- name: offset
@@ -11895,6 +16215,74 @@ paths:
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:
@@ -11917,21 +16305,17 @@ paths:
description: ''
post:
operationId: dcim_front_port_templates_create
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritableFrontPortTemplate'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableFrontPortTemplate'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableFrontPortTemplate'
+ $ref: '#/components/schemas/WritableFrontPortTemplateRequest'
required: true
security:
- cookieAuth: []
@@ -11945,21 +16329,19 @@ paths:
description: ''
put:
operationId: dcim_front_port_templates_bulk_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritableFrontPortTemplate'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableFrontPortTemplate'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableFrontPortTemplate'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableFrontPortTemplateRequest'
required: true
security:
- cookieAuth: []
@@ -11969,25 +16351,26 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/FrontPortTemplate'
+ type: array
+ items:
+ $ref: '#/components/schemas/FrontPortTemplate'
description: ''
patch:
operationId: dcim_front_port_templates_bulk_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/PatchedWritableFrontPortTemplate'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableFrontPortTemplate'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableFrontPortTemplate'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableFrontPortTemplateRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -11996,12 +16379,16 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/FrontPortTemplate'
+ type: array
+ items:
+ $ref: '#/components/schemas/FrontPortTemplate'
description: ''
delete:
operationId: dcim_front_port_templates_bulk_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -12010,11 +16397,21 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -12037,8 +16434,10 @@ paths:
description: ''
put:
operationId: dcim_front_port_templates_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -12053,13 +16452,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableFrontPortTemplate'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableFrontPortTemplate'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableFrontPortTemplate'
+ $ref: '#/components/schemas/WritableFrontPortTemplateRequest'
required: true
security:
- cookieAuth: []
@@ -12073,8 +16466,10 @@ paths:
description: ''
patch:
operationId: dcim_front_port_templates_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -12089,13 +16484,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableFrontPortTemplate'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableFrontPortTemplate'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableFrontPortTemplate'
+ $ref: '#/components/schemas/PatchedWritableFrontPortTemplateRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -12108,8 +16497,10 @@ paths:
description: ''
delete:
operationId: dcim_front_port_templates_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -12126,12 +16517,99 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -12414,6 +16892,118 @@ paths:
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
@@ -12543,6 +17133,74 @@ paths:
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:
@@ -12659,21 +17317,17 @@ paths:
description: ''
post:
operationId: dcim_front_ports_create
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritableFrontPort'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableFrontPort'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableFrontPort'
+ $ref: '#/components/schemas/WritableFrontPortRequest'
required: true
security:
- cookieAuth: []
@@ -12687,21 +17341,19 @@ paths:
description: ''
put:
operationId: dcim_front_ports_bulk_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritableFrontPort'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableFrontPort'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableFrontPort'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableFrontPortRequest'
required: true
security:
- cookieAuth: []
@@ -12711,25 +17363,26 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/FrontPort'
+ type: array
+ items:
+ $ref: '#/components/schemas/FrontPort'
description: ''
patch:
operationId: dcim_front_ports_bulk_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/PatchedWritableFrontPort'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableFrontPort'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableFrontPort'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableFrontPortRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -12738,12 +17391,16 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/FrontPort'
+ type: array
+ items:
+ $ref: '#/components/schemas/FrontPort'
description: ''
delete:
operationId: dcim_front_ports_bulk_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -12752,11 +17409,21 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -12779,8 +17446,10 @@ paths:
description: ''
put:
operationId: dcim_front_ports_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -12795,13 +17464,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableFrontPort'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableFrontPort'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableFrontPort'
+ $ref: '#/components/schemas/WritableFrontPortRequest'
required: true
security:
- cookieAuth: []
@@ -12815,8 +17478,10 @@ paths:
description: ''
patch:
operationId: dcim_front_ports_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -12831,13 +17496,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableFrontPort'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableFrontPort'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableFrontPort'
+ $ref: '#/components/schemas/PatchedWritableFrontPortRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -12850,8 +17509,10 @@ paths:
description: ''
delete:
operationId: dcim_front_ports_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -12868,6 +17529,71 @@ paths:
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
@@ -12915,61 +17641,6 @@ paths:
description: Device (ID)
explode: true
style: form
- - name: limit
- required: false
- in: query
- description: Number of results to return per page.
- schema:
- type: integer
- - name: offset
- required: false
- in: query
- description: The initial index from which to return the results.
- schema:
- type: integer
- - in: query
- name: site
- schema:
- type: string
- description: Site (slug)
- tags:
- - dcim
- security:
- - cookieAuth: []
- - tokenAuth: []
- responses:
- '200':
- content:
- application/json; version=1.3:
- schema:
- $ref: '#/components/schemas/PaginatedInterfaceConnectionList'
- description: ''
- /dcim/interface-templates/:
- get:
- operationId: dcim_interface_templates_list
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
- parameters:
- - in: query
- name: devicetype_id
- schema:
- type: array
- items:
- type: string
- format: uuid
- description: Device type (ID)
- explode: true
- style: form
- - in: query
- name: devicetype_id__n
- schema:
- type: array
- items:
- type: string
- format: uuid
- description: Device type (ID)
- explode: true
- style: form
- in: query
name: id
schema:
@@ -13102,6 +17773,475 @@ paths:
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:
@@ -13112,6 +18252,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -13120,6 +18261,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -13128,6 +18270,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -13136,6 +18279,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -13144,6 +18288,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -13152,6 +18297,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -13160,6 +18306,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -13168,6 +18315,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -13176,6 +18324,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -13184,6 +18333,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -13192,6 +18342,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -13200,6 +18351,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -13208,6 +18360,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -13216,6 +18369,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- name: offset
@@ -13251,21 +18405,17 @@ paths:
description: ''
post:
operationId: dcim_interface_templates_create
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritableInterfaceTemplate'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableInterfaceTemplate'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableInterfaceTemplate'
+ $ref: '#/components/schemas/WritableInterfaceTemplateRequest'
required: true
security:
- cookieAuth: []
@@ -13279,21 +18429,19 @@ paths:
description: ''
put:
operationId: dcim_interface_templates_bulk_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritableInterfaceTemplate'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableInterfaceTemplate'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableInterfaceTemplate'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableInterfaceTemplateRequest'
required: true
security:
- cookieAuth: []
@@ -13303,25 +18451,26 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/InterfaceTemplate'
+ type: array
+ items:
+ $ref: '#/components/schemas/InterfaceTemplate'
description: ''
patch:
operationId: dcim_interface_templates_bulk_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/PatchedWritableInterfaceTemplate'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableInterfaceTemplate'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableInterfaceTemplate'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableInterfaceTemplateRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -13330,12 +18479,16 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/InterfaceTemplate'
+ type: array
+ items:
+ $ref: '#/components/schemas/InterfaceTemplate'
description: ''
delete:
operationId: dcim_interface_templates_bulk_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -13344,11 +18497,21 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -13371,8 +18534,10 @@ paths:
description: ''
put:
operationId: dcim_interface_templates_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -13387,13 +18552,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableInterfaceTemplate'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableInterfaceTemplate'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableInterfaceTemplate'
+ $ref: '#/components/schemas/WritableInterfaceTemplateRequest'
required: true
security:
- cookieAuth: []
@@ -13407,8 +18566,10 @@ paths:
description: ''
patch:
operationId: dcim_interface_templates_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -13423,13 +18584,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableInterfaceTemplate'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableInterfaceTemplate'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableInterfaceTemplate'
+ $ref: '#/components/schemas/PatchedWritableInterfaceTemplateRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -13442,8 +18597,10 @@ paths:
description: ''
delete:
operationId: dcim_interface_templates_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -13460,16 +18617,163 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -13606,10 +18910,36 @@ paths:
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:
@@ -13741,6 +19071,138 @@ paths:
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:
@@ -13893,6 +19355,26 @@ paths:
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:
@@ -14065,12 +19547,158 @@ paths:
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:
@@ -14154,6 +19782,24 @@ paths:
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:
@@ -14170,6 +19816,26 @@ paths:
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:
@@ -14186,6 +19852,26 @@ paths:
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:
@@ -14206,25 +19892,21 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/PaginatedInterfaceList'
+ $ref: '#/components/schemas/PaginatedInterfaceSerializerVersion12List'
description: ''
post:
operationId: dcim_interfaces_create
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritableInterface'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableInterface'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableInterface'
+ $ref: '#/components/schemas/WritableInterfaceRequest'
required: true
security:
- cookieAuth: []
@@ -14234,25 +19916,23 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/Interface'
+ $ref: '#/components/schemas/InterfaceSerializerVersion12'
description: ''
put:
operationId: dcim_interfaces_bulk_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritableInterface'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableInterface'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableInterface'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableInterfaceRequest'
required: true
security:
- cookieAuth: []
@@ -14262,25 +19942,26 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/Interface'
+ type: array
+ items:
+ $ref: '#/components/schemas/InterfaceSerializerVersion12'
description: ''
patch:
operationId: dcim_interfaces_bulk_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/PatchedWritableInterface'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableInterface'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableInterface'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableInterfaceRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -14289,12 +19970,16 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/Interface'
+ type: array
+ items:
+ $ref: '#/components/schemas/InterfaceSerializerVersion12'
description: ''
delete:
operationId: dcim_interfaces_bulk_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -14303,11 +19988,21 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -14326,12 +20021,14 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/Interface'
+ $ref: '#/components/schemas/InterfaceSerializerVersion12'
description: ''
put:
operationId: dcim_interfaces_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -14346,13 +20043,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableInterface'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableInterface'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableInterface'
+ $ref: '#/components/schemas/WritableInterfaceRequest'
required: true
security:
- cookieAuth: []
@@ -14362,12 +20053,14 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/Interface'
+ $ref: '#/components/schemas/InterfaceSerializerVersion12'
description: ''
patch:
operationId: dcim_interfaces_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -14382,13 +20075,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableInterface'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableInterface'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableInterface'
+ $ref: '#/components/schemas/PatchedWritableInterfaceRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -14397,12 +20084,14 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/Interface'
+ $ref: '#/components/schemas/InterfaceSerializerVersion12'
description: ''
delete:
operationId: dcim_interfaces_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -14419,6 +20108,71 @@ paths:
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
@@ -14447,8 +20201,10 @@ paths:
/dcim/inventory-items/:
get:
operationId: dcim_inventory_items_list
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -14562,6 +20318,138 @@ paths:
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:
@@ -14590,6 +20478,11 @@ paths:
name: discovered
schema:
type: boolean
+ - in: query
+ name: has_child_items
+ schema:
+ type: boolean
+ description: Has child items
- in: query
name: id
schema:
@@ -14716,6 +20609,118 @@ paths:
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
@@ -14880,6 +20885,26 @@ paths:
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:
@@ -15131,21 +21156,17 @@ paths:
description: ''
post:
operationId: dcim_inventory_items_create
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritableInventoryItem'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableInventoryItem'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableInventoryItem'
+ $ref: '#/components/schemas/WritableInventoryItemRequest'
required: true
security:
- cookieAuth: []
@@ -15159,21 +21180,19 @@ paths:
description: ''
put:
operationId: dcim_inventory_items_bulk_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritableInventoryItem'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableInventoryItem'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableInventoryItem'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableInventoryItemRequest'
required: true
security:
- cookieAuth: []
@@ -15183,25 +21202,26 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/InventoryItem'
+ type: array
+ items:
+ $ref: '#/components/schemas/InventoryItem'
description: ''
patch:
operationId: dcim_inventory_items_bulk_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/PatchedWritableInventoryItem'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableInventoryItem'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableInventoryItem'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableInventoryItemRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -15210,12 +21230,16 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/InventoryItem'
+ type: array
+ items:
+ $ref: '#/components/schemas/InventoryItem'
description: ''
delete:
operationId: dcim_inventory_items_bulk_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -15224,11 +21248,21 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -15251,8 +21285,10 @@ paths:
description: ''
put:
operationId: dcim_inventory_items_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -15267,13 +21303,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableInventoryItem'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableInventoryItem'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableInventoryItem'
+ $ref: '#/components/schemas/WritableInventoryItemRequest'
required: true
security:
- cookieAuth: []
@@ -15287,8 +21317,10 @@ paths:
description: ''
patch:
operationId: dcim_inventory_items_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -15303,13 +21335,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableInventoryItem'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableInventoryItem'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableInventoryItem'
+ $ref: '#/components/schemas/PatchedWritableInventoryItemRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -15322,8 +21348,10 @@ paths:
description: ''
delete:
operationId: dcim_inventory_items_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -15340,12 +21368,95 @@ paths:
responses:
'204':
description: No response body
- /dcim/manufacturers/:
+ /dcim/inventory-items/{id}/notes/:
get:
- operationId: dcim_manufacturers_list
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ 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:
@@ -15732,12 +21843,1928 @@ paths:
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:
@@ -15869,21 +23896,17 @@ paths:
description: ''
post:
operationId: dcim_manufacturers_create
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/Manufacturer'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/Manufacturer'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/Manufacturer'
+ $ref: '#/components/schemas/ManufacturerRequest'
required: true
security:
- cookieAuth: []
@@ -15897,21 +23920,19 @@ paths:
description: ''
put:
operationId: dcim_manufacturers_bulk_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/Manufacturer'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/Manufacturer'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/Manufacturer'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableManufacturerRequest'
required: true
security:
- cookieAuth: []
@@ -15921,25 +23942,26 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/Manufacturer'
+ type: array
+ items:
+ $ref: '#/components/schemas/Manufacturer'
description: ''
patch:
operationId: dcim_manufacturers_bulk_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/PatchedManufacturer'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedManufacturer'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedManufacturer'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableManufacturerRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -15948,12 +23970,16 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/Manufacturer'
+ type: array
+ items:
+ $ref: '#/components/schemas/Manufacturer'
description: ''
delete:
operationId: dcim_manufacturers_bulk_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -15962,11 +23988,21 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -15989,8 +24025,10 @@ paths:
description: ''
put:
operationId: dcim_manufacturers_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -16005,13 +24043,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Manufacturer'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/Manufacturer'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/Manufacturer'
+ $ref: '#/components/schemas/ManufacturerRequest'
required: true
security:
- cookieAuth: []
@@ -16025,8 +24057,10 @@ paths:
description: ''
patch:
operationId: dcim_manufacturers_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -16041,13 +24075,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedManufacturer'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedManufacturer'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedManufacturer'
+ $ref: '#/components/schemas/PatchedManufacturerRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -16060,8 +24088,10 @@ paths:
description: ''
delete:
operationId: dcim_manufacturers_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -16078,11 +24108,78 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -16211,6 +24308,34 @@ paths:
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:
@@ -16508,6 +24633,14 @@ paths:
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:
@@ -16743,6 +24876,24 @@ paths:
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:
@@ -16757,21 +24908,17 @@ paths:
description: ''
post:
operationId: dcim_platforms_create
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritablePlatform'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritablePlatform'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritablePlatform'
+ $ref: '#/components/schemas/WritablePlatformRequest'
required: true
security:
- cookieAuth: []
@@ -16785,21 +24932,19 @@ paths:
description: ''
put:
operationId: dcim_platforms_bulk_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritablePlatform'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritablePlatform'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritablePlatform'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritablePlatformRequest'
required: true
security:
- cookieAuth: []
@@ -16809,25 +24954,26 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/Platform'
+ type: array
+ items:
+ $ref: '#/components/schemas/Platform'
description: ''
patch:
operationId: dcim_platforms_bulk_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/PatchedWritablePlatform'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritablePlatform'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritablePlatform'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritablePlatformRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -16836,12 +24982,16 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/Platform'
+ type: array
+ items:
+ $ref: '#/components/schemas/Platform'
description: ''
delete:
operationId: dcim_platforms_bulk_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -16850,11 +25000,21 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -16877,8 +25037,10 @@ paths:
description: ''
put:
operationId: dcim_platforms_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -16893,13 +25055,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritablePlatform'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritablePlatform'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritablePlatform'
+ $ref: '#/components/schemas/WritablePlatformRequest'
required: true
security:
- cookieAuth: []
@@ -16913,8 +25069,10 @@ paths:
description: ''
patch:
operationId: dcim_platforms_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -16929,13 +25087,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritablePlatform'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritablePlatform'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritablePlatform'
+ $ref: '#/components/schemas/PatchedWritablePlatformRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -16948,8 +25100,10 @@ paths:
description: ''
delete:
operationId: dcim_platforms_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -16966,6 +25120,71 @@ paths:
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
@@ -16989,6 +25208,132 @@ paths:
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
@@ -17184,10 +25529,190 @@ paths:
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:
@@ -17529,6 +26054,26 @@ paths:
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:
@@ -17554,6 +26099,26 @@ paths:
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:
@@ -17772,13 +26337,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritablePowerFeed'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritablePowerFeed'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritablePowerFeed'
+ $ref: '#/components/schemas/WritablePowerFeedRequest'
required: true
security:
- cookieAuth: []
@@ -17800,13 +26359,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritablePowerFeed'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritablePowerFeed'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritablePowerFeed'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritablePowerFeedRequest'
required: true
security:
- cookieAuth: []
@@ -17816,7 +26371,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/PowerFeed'
+ type: array
+ items:
+ $ref: '#/components/schemas/PowerFeed'
description: ''
patch:
operationId: dcim_power_feeds_bulk_partial_update
@@ -17828,13 +26385,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritablePowerFeed'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritablePowerFeed'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritablePowerFeed'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritablePowerFeedRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -17843,7 +26397,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/PowerFeed'
+ type: array
+ items:
+ $ref: '#/components/schemas/PowerFeed'
description: ''
delete:
operationId: dcim_power_feeds_bulk_destroy
@@ -17857,6 +26413,14 @@ paths:
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
@@ -17900,13 +26464,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritablePowerFeed'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritablePowerFeed'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritablePowerFeed'
+ $ref: '#/components/schemas/WritablePowerFeedRequest'
required: true
security:
- cookieAuth: []
@@ -17936,13 +26494,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritablePowerFeed'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritablePowerFeed'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritablePowerFeed'
+ $ref: '#/components/schemas/PatchedWritablePowerFeedRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -17973,6 +26525,71 @@ paths:
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
@@ -18001,9 +26618,157 @@ paths:
/dcim/power-outlet-templates/:
get:
operationId: dcim_power_outlet_templates_list
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -18041,6 +26806,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -18050,6 +26816,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -18059,6 +26826,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -18068,6 +26836,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -18077,6 +26846,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -18086,6 +26856,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -18095,6 +26866,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -18104,6 +26876,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -18113,6 +26886,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -18122,6 +26896,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -18131,6 +26906,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -18140,6 +26916,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -18149,6 +26926,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -18158,6 +26936,133 @@ paths:
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
@@ -18172,6 +27077,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -18180,6 +27086,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -18188,6 +27095,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -18196,6 +27104,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -18204,6 +27113,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -18212,6 +27122,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -18220,6 +27131,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -18228,6 +27140,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -18236,6 +27149,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -18244,6 +27158,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -18252,6 +27167,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -18260,6 +27176,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -18268,6 +27185,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -18276,6 +27194,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- name: offset
@@ -18284,6 +27203,26 @@ paths:
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:
@@ -18311,21 +27250,17 @@ paths:
description: ''
post:
operationId: dcim_power_outlet_templates_create
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritablePowerOutletTemplate'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritablePowerOutletTemplate'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritablePowerOutletTemplate'
+ $ref: '#/components/schemas/WritablePowerOutletTemplateRequest'
required: true
security:
- cookieAuth: []
@@ -18339,21 +27274,19 @@ paths:
description: ''
put:
operationId: dcim_power_outlet_templates_bulk_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritablePowerOutletTemplate'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritablePowerOutletTemplate'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritablePowerOutletTemplate'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritablePowerOutletTemplateRequest'
required: true
security:
- cookieAuth: []
@@ -18363,25 +27296,26 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/PowerOutletTemplate'
+ type: array
+ items:
+ $ref: '#/components/schemas/PowerOutletTemplate'
description: ''
patch:
operationId: dcim_power_outlet_templates_bulk_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/PatchedWritablePowerOutletTemplate'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritablePowerOutletTemplate'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritablePowerOutletTemplate'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritablePowerOutletTemplateRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -18390,12 +27324,16 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/PowerOutletTemplate'
+ type: array
+ items:
+ $ref: '#/components/schemas/PowerOutletTemplate'
description: ''
delete:
operationId: dcim_power_outlet_templates_bulk_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -18404,11 +27342,21 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -18431,8 +27379,10 @@ paths:
description: ''
put:
operationId: dcim_power_outlet_templates_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -18447,13 +27397,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritablePowerOutletTemplate'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritablePowerOutletTemplate'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritablePowerOutletTemplate'
+ $ref: '#/components/schemas/WritablePowerOutletTemplateRequest'
required: true
security:
- cookieAuth: []
@@ -18467,8 +27411,10 @@ paths:
description: ''
patch:
operationId: dcim_power_outlet_templates_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -18483,13 +27429,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritablePowerOutletTemplate'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritablePowerOutletTemplate'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritablePowerOutletTemplate'
+ $ref: '#/components/schemas/PatchedWritablePowerOutletTemplateRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -18502,8 +27442,10 @@ paths:
description: ''
delete:
operationId: dcim_power_outlet_templates_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -18520,12 +27462,99 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -18823,6 +27852,118 @@ paths:
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
@@ -18947,6 +28088,26 @@ paths:
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:
@@ -19078,21 +28239,17 @@ paths:
description: ''
post:
operationId: dcim_power_outlets_create
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritablePowerOutlet'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritablePowerOutlet'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritablePowerOutlet'
+ $ref: '#/components/schemas/WritablePowerOutletRequest'
required: true
security:
- cookieAuth: []
@@ -19106,21 +28263,19 @@ paths:
description: ''
put:
operationId: dcim_power_outlets_bulk_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritablePowerOutlet'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritablePowerOutlet'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritablePowerOutlet'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritablePowerOutletRequest'
required: true
security:
- cookieAuth: []
@@ -19130,25 +28285,26 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/PowerOutlet'
+ type: array
+ items:
+ $ref: '#/components/schemas/PowerOutlet'
description: ''
patch:
operationId: dcim_power_outlets_bulk_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/PatchedWritablePowerOutlet'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritablePowerOutlet'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritablePowerOutlet'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritablePowerOutletRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -19157,12 +28313,16 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/PowerOutlet'
+ type: array
+ items:
+ $ref: '#/components/schemas/PowerOutlet'
description: ''
delete:
operationId: dcim_power_outlets_bulk_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -19171,11 +28331,21 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -19198,8 +28368,10 @@ paths:
description: ''
put:
operationId: dcim_power_outlets_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -19214,13 +28386,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritablePowerOutlet'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritablePowerOutlet'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritablePowerOutlet'
+ $ref: '#/components/schemas/WritablePowerOutletRequest'
required: true
security:
- cookieAuth: []
@@ -19234,8 +28400,10 @@ paths:
description: ''
patch:
operationId: dcim_power_outlets_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -19250,13 +28418,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritablePowerOutlet'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritablePowerOutlet'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritablePowerOutlet'
+ $ref: '#/components/schemas/PatchedWritablePowerOutletRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -19269,8 +28431,10 @@ paths:
description: ''
delete:
operationId: dcim_power_outlets_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -19287,6 +28451,71 @@ paths:
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
@@ -19315,7 +28544,10 @@ paths:
/dcim/power-panels/:
get:
operationId: dcim_power_panels_list
- description: Extend DRF's ModelViewSet to support bulk update and delete functions.
+ description: |-
+ Base class to 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
@@ -19332,6 +28564,11 @@ paths:
schema:
type: string
format: date
+ - in: query
+ name: has_power_feeds
+ schema:
+ type: boolean
+ description: Has power feeds
- in: query
name: id
schema:
@@ -19479,6 +28716,26 @@ paths:
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:
@@ -19597,11 +28854,51 @@ paths:
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:
@@ -19629,7 +28926,7 @@ paths:
items:
type: string
format: uuid
- description: Region (slug)
+ description: Region (slug or ID)
explode: true
style: form
- in: query
@@ -19639,7 +28936,7 @@ paths:
items:
type: string
format: uuid
- description: Region (slug)
+ description: Region (slug or ID)
explode: true
style: form
- in: query
@@ -19649,7 +28946,7 @@ paths:
items:
type: string
format: uuid
- description: Region (ID)
+ description: Region (ID) (deprecated, use "region" filter instead)
explode: true
style: form
- in: query
@@ -19659,7 +28956,7 @@ paths:
items:
type: string
format: uuid
- description: Region (ID)
+ description: Region (ID) (deprecated, use "region" filter instead)
explode: true
style: form
- in: query
@@ -19668,7 +28965,8 @@ paths:
type: array
items:
type: string
- description: Site name (slug)
+ format: uuid
+ description: Site (slug or ID)
explode: true
style: form
- in: query
@@ -19677,7 +28975,8 @@ paths:
type: array
items:
type: string
- description: Site name (slug)
+ format: uuid
+ description: Site (slug or ID)
explode: true
style: form
- in: query
@@ -19687,7 +28986,7 @@ paths:
items:
type: string
format: uuid
- description: Site (ID)
+ description: Site (ID) (deprecated, use "site" filter instead)
explode: true
style: form
- in: query
@@ -19697,7 +28996,7 @@ paths:
items:
type: string
format: uuid
- description: Site (ID)
+ description: Site (ID) (deprecated, use "site" filter instead)
explode: true
style: form
- in: query
@@ -19730,20 +29029,17 @@ paths:
description: ''
post:
operationId: dcim_power_panels_create
- description: Extend DRF's ModelViewSet to support bulk update and delete functions.
+ description: |-
+ Base class to 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/WritablePowerPanel'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritablePowerPanel'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritablePowerPanel'
+ $ref: '#/components/schemas/WritablePowerPanelRequest'
required: true
security:
- cookieAuth: []
@@ -19757,20 +29053,19 @@ paths:
description: ''
put:
operationId: dcim_power_panels_bulk_update
- description: Extend DRF's ModelViewSet to support bulk update and delete functions.
+ description: |-
+ Base class to 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/WritablePowerPanel'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritablePowerPanel'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritablePowerPanel'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritablePowerPanelRequest'
required: true
security:
- cookieAuth: []
@@ -19780,24 +29075,26 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/PowerPanel'
+ type: array
+ items:
+ $ref: '#/components/schemas/PowerPanel'
description: ''
patch:
operationId: dcim_power_panels_bulk_partial_update
- description: Extend DRF's ModelViewSet to support bulk update and delete functions.
+ description: |-
+ Base class to 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/PatchedWritablePowerPanel'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritablePowerPanel'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritablePowerPanel'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritablePowerPanelRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -19806,11 +29103,16 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/PowerPanel'
+ type: array
+ items:
+ $ref: '#/components/schemas/PowerPanel'
description: ''
delete:
operationId: dcim_power_panels_bulk_destroy
- description: Extend DRF's ModelViewSet to support bulk update and delete functions.
+ description: |-
+ Base class to 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:
@@ -19819,10 +29121,21 @@ paths:
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: Extend DRF's ModelViewSet to support bulk update and delete functions.
+ description: |-
+ Base class to 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
@@ -19845,7 +29158,10 @@ paths:
description: ''
put:
operationId: dcim_power_panels_update
- description: Extend DRF's ModelViewSet to support bulk update and delete functions.
+ description: |-
+ Base class to 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
@@ -19860,13 +29176,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritablePowerPanel'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritablePowerPanel'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritablePowerPanel'
+ $ref: '#/components/schemas/WritablePowerPanelRequest'
required: true
security:
- cookieAuth: []
@@ -19880,7 +29190,10 @@ paths:
description: ''
patch:
operationId: dcim_power_panels_partial_update
- description: Extend DRF's ModelViewSet to support bulk update and delete functions.
+ description: |-
+ Base class to 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
@@ -19895,13 +29208,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritablePowerPanel'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritablePowerPanel'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritablePowerPanel'
+ $ref: '#/components/schemas/PatchedWritablePowerPanelRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -19914,7 +29221,10 @@ paths:
description: ''
delete:
operationId: dcim_power_panels_destroy
- description: Extend DRF's ModelViewSet to support bulk update and delete functions.
+ description: |-
+ Base class to 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
@@ -19931,11 +29241,78 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -19985,6 +29362,152 @@ paths:
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:
@@ -20005,6 +29528,11 @@ paths:
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:
@@ -20012,6 +29540,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -20021,6 +29550,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -20030,6 +29560,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -20039,6 +29570,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -20048,6 +29580,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -20057,6 +29590,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -20066,6 +29600,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -20075,6 +29610,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -20084,6 +29620,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -20093,6 +29630,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -20102,6 +29640,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -20111,6 +29650,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -20120,6 +29660,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -20129,6 +29670,133 @@ paths:
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
@@ -20191,6 +29859,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -20199,6 +29868,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -20207,6 +29877,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -20215,6 +29886,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -20223,6 +29895,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -20231,6 +29904,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -20239,6 +29913,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -20247,6 +29922,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -20255,6 +29931,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -20263,6 +29940,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -20271,6 +29949,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -20279,6 +29958,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -20287,6 +29967,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -20295,6 +29976,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- name: offset
@@ -20303,6 +29985,26 @@ paths:
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:
@@ -20330,21 +30032,17 @@ paths:
description: ''
post:
operationId: dcim_power_port_templates_create
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritablePowerPortTemplate'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritablePowerPortTemplate'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritablePowerPortTemplate'
+ $ref: '#/components/schemas/WritablePowerPortTemplateRequest'
required: true
security:
- cookieAuth: []
@@ -20358,21 +30056,19 @@ paths:
description: ''
put:
operationId: dcim_power_port_templates_bulk_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritablePowerPortTemplate'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritablePowerPortTemplate'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritablePowerPortTemplate'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritablePowerPortTemplateRequest'
required: true
security:
- cookieAuth: []
@@ -20382,25 +30078,26 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/PowerPortTemplate'
+ type: array
+ items:
+ $ref: '#/components/schemas/PowerPortTemplate'
description: ''
patch:
operationId: dcim_power_port_templates_bulk_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/PatchedWritablePowerPortTemplate'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritablePowerPortTemplate'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritablePowerPortTemplate'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritablePowerPortTemplateRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -20409,12 +30106,16 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/PowerPortTemplate'
+ type: array
+ items:
+ $ref: '#/components/schemas/PowerPortTemplate'
description: ''
delete:
operationId: dcim_power_port_templates_bulk_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -20423,11 +30124,21 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -20450,8 +30161,10 @@ paths:
description: ''
put:
operationId: dcim_power_port_templates_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -20466,13 +30179,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritablePowerPortTemplate'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritablePowerPortTemplate'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritablePowerPortTemplate'
+ $ref: '#/components/schemas/WritablePowerPortTemplateRequest'
required: true
security:
- cookieAuth: []
@@ -20486,8 +30193,10 @@ paths:
description: ''
patch:
operationId: dcim_power_port_templates_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -20502,13 +30211,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritablePowerPortTemplate'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritablePowerPortTemplate'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritablePowerPortTemplate'
+ $ref: '#/components/schemas/PatchedWritablePowerPortTemplateRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -20521,8 +30224,10 @@ paths:
description: ''
delete:
operationId: dcim_power_port_templates_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -20539,11 +30244,78 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -20593,6 +30365,26 @@ paths:
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:
@@ -20754,6 +30546,11 @@ paths:
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:
@@ -20880,6 +30677,118 @@ paths:
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
@@ -21052,6 +30961,26 @@ paths:
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:
@@ -21183,21 +31112,17 @@ paths:
description: ''
post:
operationId: dcim_power_ports_create
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritablePowerPort'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritablePowerPort'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritablePowerPort'
+ $ref: '#/components/schemas/WritablePowerPortRequest'
required: true
security:
- cookieAuth: []
@@ -21211,21 +31136,19 @@ paths:
description: ''
put:
operationId: dcim_power_ports_bulk_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritablePowerPort'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritablePowerPort'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritablePowerPort'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritablePowerPortRequest'
required: true
security:
- cookieAuth: []
@@ -21235,25 +31158,26 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/PowerPort'
+ type: array
+ items:
+ $ref: '#/components/schemas/PowerPort'
description: ''
patch:
operationId: dcim_power_ports_bulk_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/PatchedWritablePowerPort'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritablePowerPort'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritablePowerPort'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritablePowerPortRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -21262,12 +31186,16 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/PowerPort'
+ type: array
+ items:
+ $ref: '#/components/schemas/PowerPort'
description: ''
delete:
operationId: dcim_power_ports_bulk_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -21276,11 +31204,21 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -21303,8 +31241,10 @@ paths:
description: ''
put:
operationId: dcim_power_ports_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -21319,13 +31259,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritablePowerPort'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritablePowerPort'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritablePowerPort'
+ $ref: '#/components/schemas/WritablePowerPortRequest'
required: true
security:
- cookieAuth: []
@@ -21339,8 +31273,10 @@ paths:
description: ''
patch:
operationId: dcim_power_ports_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -21355,13 +31291,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritablePowerPort'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritablePowerPort'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritablePowerPort'
+ $ref: '#/components/schemas/PatchedWritablePowerPortRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -21374,8 +31304,10 @@ paths:
description: ''
delete:
operationId: dcim_power_ports_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -21392,6 +31324,71 @@ paths:
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
@@ -21420,9 +31417,31 @@ paths:
/dcim/rack-groups/:
get:
operationId: dcim_rack_groups_list
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -21550,6 +31569,21 @@ paths:
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:
@@ -21697,6 +31731,26 @@ paths:
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:
@@ -21821,7 +31875,7 @@ paths:
type: array
items:
type: string
- description: Rack group (slug)
+ description: Parent (slug)
explode: true
style: form
- in: query
@@ -21830,7 +31884,7 @@ paths:
type: array
items:
type: string
- description: Rack group (slug)
+ description: Parent (slug)
explode: true
style: form
- in: query
@@ -21841,7 +31895,7 @@ paths:
type: string
format: uuid
nullable: true
- description: Rack group (ID)
+ description: Parent (ID)
explode: true
style: form
- in: query
@@ -21852,7 +31906,27 @@ paths:
type: string
format: uuid
nullable: true
- description: Rack group (ID)
+ 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
@@ -21860,6 +31934,24 @@ paths:
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:
@@ -21867,7 +31959,7 @@ paths:
items:
type: string
format: uuid
- description: Region (slug)
+ description: Region (slug or ID)
explode: true
style: form
- in: query
@@ -21877,7 +31969,7 @@ paths:
items:
type: string
format: uuid
- description: Region (slug)
+ description: Region (slug or ID)
explode: true
style: form
- in: query
@@ -21887,7 +31979,7 @@ paths:
items:
type: string
format: uuid
- description: Region (ID)
+ description: Region (ID) (deprecated, use "region" filter instead)
explode: true
style: form
- in: query
@@ -21897,7 +31989,7 @@ paths:
items:
type: string
format: uuid
- description: Region (ID)
+ description: Region (ID) (deprecated, use "region" filter instead)
explode: true
style: form
- in: query
@@ -21906,7 +31998,8 @@ paths:
type: array
items:
type: string
- description: Site (slug)
+ format: uuid
+ description: Site (slug or ID)
explode: true
style: form
- in: query
@@ -21915,7 +32008,8 @@ paths:
type: array
items:
type: string
- description: Site (slug)
+ format: uuid
+ description: Site (slug or ID)
explode: true
style: form
- in: query
@@ -21925,7 +32019,7 @@ paths:
items:
type: string
format: uuid
- description: Site (ID)
+ description: Site (ID) (deprecated, use "site" filter instead)
explode: true
style: form
- in: query
@@ -21935,7 +32029,7 @@ paths:
items:
type: string
format: uuid
- description: Site (ID)
+ description: Site (ID) (deprecated, use "site" filter instead)
explode: true
style: form
- in: query
@@ -22064,21 +32158,17 @@ paths:
description: ''
post:
operationId: dcim_rack_groups_create
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritableRackGroup'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableRackGroup'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableRackGroup'
+ $ref: '#/components/schemas/WritableRackGroupRequest'
required: true
security:
- cookieAuth: []
@@ -22092,21 +32182,19 @@ paths:
description: ''
put:
operationId: dcim_rack_groups_bulk_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritableRackGroup'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableRackGroup'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableRackGroup'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableRackGroupRequest'
required: true
security:
- cookieAuth: []
@@ -22116,25 +32204,26 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/RackGroup'
+ type: array
+ items:
+ $ref: '#/components/schemas/RackGroup'
description: ''
patch:
operationId: dcim_rack_groups_bulk_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/PatchedWritableRackGroup'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableRackGroup'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableRackGroup'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableRackGroupRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -22143,12 +32232,16 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/RackGroup'
+ type: array
+ items:
+ $ref: '#/components/schemas/RackGroup'
description: ''
delete:
operationId: dcim_rack_groups_bulk_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -22157,11 +32250,21 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -22184,8 +32287,10 @@ paths:
description: ''
put:
operationId: dcim_rack_groups_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -22200,13 +32305,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableRackGroup'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableRackGroup'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableRackGroup'
+ $ref: '#/components/schemas/WritableRackGroupRequest'
required: true
security:
- cookieAuth: []
@@ -22220,8 +32319,10 @@ paths:
description: ''
patch:
operationId: dcim_rack_groups_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -22236,13 +32337,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableRackGroup'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableRackGroup'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableRackGroup'
+ $ref: '#/components/schemas/PatchedWritableRackGroupRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -22255,8 +32350,10 @@ paths:
description: ''
delete:
operationId: dcim_rack_groups_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -22273,10 +32370,78 @@ paths:
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: Extend DRF's ModelViewSet to support bulk update and delete functions.
+ description: |-
+ Base class to 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
@@ -22293,6 +32458,118 @@ paths:
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:
@@ -22491,6 +32768,26 @@ paths:
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:
@@ -22571,7 +32868,8 @@ paths:
type: array
items:
type: string
- description: Tenant (slug)
+ format: uuid
+ description: Tenant (slug or ID)
explode: true
style: form
- in: query
@@ -22580,7 +32878,8 @@ paths:
type: array
items:
type: string
- description: Tenant (slug)
+ format: uuid
+ description: Tenant (slug or ID)
explode: true
style: form
- in: query
@@ -22631,7 +32930,7 @@ paths:
type: string
format: uuid
nullable: true
- description: Tenant (ID)
+ description: Tenant (ID) (deprecated, use "tenant" filter instead)
explode: true
style: form
- in: query
@@ -22642,7 +32941,7 @@ paths:
type: string
format: uuid
nullable: true
- description: Tenant (ID)
+ description: Tenant (ID) (deprecated, use "tenant" filter instead)
explode: true
style: form
- in: query
@@ -22697,20 +32996,17 @@ paths:
description: ''
post:
operationId: dcim_rack_reservations_create
- description: Extend DRF's ModelViewSet to support bulk update and delete functions.
+ description: |-
+ Base class to 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/WritableRackReservation'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableRackReservation'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableRackReservation'
+ $ref: '#/components/schemas/WritableRackReservationRequest'
required: true
security:
- cookieAuth: []
@@ -22724,20 +33020,19 @@ paths:
description: ''
put:
operationId: dcim_rack_reservations_bulk_update
- description: Extend DRF's ModelViewSet to support bulk update and delete functions.
+ description: |-
+ Base class to 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/WritableRackReservation'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableRackReservation'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableRackReservation'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableRackReservationRequest'
required: true
security:
- cookieAuth: []
@@ -22747,24 +33042,26 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/RackReservation'
+ type: array
+ items:
+ $ref: '#/components/schemas/RackReservation'
description: ''
patch:
operationId: dcim_rack_reservations_bulk_partial_update
- description: Extend DRF's ModelViewSet to support bulk update and delete functions.
+ description: |-
+ Base class to 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/PatchedWritableRackReservation'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableRackReservation'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableRackReservation'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableRackReservationRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -22773,11 +33070,16 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/RackReservation'
+ type: array
+ items:
+ $ref: '#/components/schemas/RackReservation'
description: ''
delete:
operationId: dcim_rack_reservations_bulk_destroy
- description: Extend DRF's ModelViewSet to support bulk update and delete functions.
+ description: |-
+ Base class to 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:
@@ -22786,10 +33088,21 @@ paths:
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: Extend DRF's ModelViewSet to support bulk update and delete functions.
+ description: |-
+ Base class to 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
@@ -22812,7 +33125,10 @@ paths:
description: ''
put:
operationId: dcim_rack_reservations_update
- description: Extend DRF's ModelViewSet to support bulk update and delete functions.
+ description: |-
+ Base class to 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
@@ -22827,13 +33143,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableRackReservation'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableRackReservation'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableRackReservation'
+ $ref: '#/components/schemas/WritableRackReservationRequest'
required: true
security:
- cookieAuth: []
@@ -22847,7 +33157,10 @@ paths:
description: ''
patch:
operationId: dcim_rack_reservations_partial_update
- description: Extend DRF's ModelViewSet to support bulk update and delete functions.
+ description: |-
+ Base class to 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
@@ -22862,13 +33175,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableRackReservation'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableRackReservation'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableRackReservation'
+ $ref: '#/components/schemas/PatchedWritableRackReservationRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -22881,7 +33188,10 @@ paths:
description: ''
delete:
operationId: dcim_rack_reservations_destroy
- description: Extend DRF's ModelViewSet to support bulk update and delete functions.
+ description: |-
+ Base class to 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
@@ -22898,11 +33208,78 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -23031,6 +33408,123 @@ paths:
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:
@@ -23301,6 +33795,24 @@ paths:
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:
@@ -23427,21 +33939,17 @@ paths:
description: ''
post:
operationId: dcim_rack_roles_create
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/RackRole'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/RackRole'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/RackRole'
+ $ref: '#/components/schemas/RackRoleRequest'
required: true
security:
- cookieAuth: []
@@ -23455,21 +33963,19 @@ paths:
description: ''
put:
operationId: dcim_rack_roles_bulk_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/RackRole'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/RackRole'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/RackRole'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableRackRoleRequest'
required: true
security:
- cookieAuth: []
@@ -23479,25 +33985,26 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/RackRole'
+ type: array
+ items:
+ $ref: '#/components/schemas/RackRole'
description: ''
patch:
operationId: dcim_rack_roles_bulk_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/PatchedRackRole'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedRackRole'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedRackRole'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableRackRoleRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -23506,12 +34013,16 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/RackRole'
+ type: array
+ items:
+ $ref: '#/components/schemas/RackRole'
description: ''
delete:
operationId: dcim_rack_roles_bulk_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -23520,11 +34031,21 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -23547,8 +34068,10 @@ paths:
description: ''
put:
operationId: dcim_rack_roles_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -23563,13 +34086,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/RackRole'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/RackRole'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/RackRole'
+ $ref: '#/components/schemas/RackRoleRequest'
required: true
security:
- cookieAuth: []
@@ -23583,8 +34100,10 @@ paths:
description: ''
patch:
operationId: dcim_rack_roles_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -23599,13 +34118,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedRackRole'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedRackRole'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedRackRole'
+ $ref: '#/components/schemas/PatchedRackRoleRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -23618,8 +34131,10 @@ paths:
description: ''
delete:
operationId: dcim_rack_roles_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -23636,6 +34151,71 @@ paths:
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
@@ -23754,6 +34334,118 @@ paths:
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:
@@ -23773,6 +34465,24 @@ paths:
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:
@@ -23925,6 +34635,21 @@ paths:
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:
@@ -24072,6 +34797,26 @@ paths:
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:
@@ -24294,6 +35039,26 @@ paths:
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:
@@ -24306,7 +35071,7 @@ paths:
items:
type: string
format: uuid
- description: Region (slug)
+ description: Region (slug or ID)
explode: true
style: form
- in: query
@@ -24316,7 +35081,7 @@ paths:
items:
type: string
format: uuid
- description: Region (slug)
+ description: Region (slug or ID)
explode: true
style: form
- in: query
@@ -24326,7 +35091,7 @@ paths:
items:
type: string
format: uuid
- description: Region (ID)
+ description: Region (ID) (deprecated, use "region" filter instead)
explode: true
style: form
- in: query
@@ -24336,7 +35101,25 @@ paths:
items:
type: string
format: uuid
- description: Region (ID)
+ 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
@@ -24389,7 +35172,8 @@ paths:
type: array
items:
type: string
- description: Site (slug)
+ format: uuid
+ description: Site (slug or ID)
explode: true
style: form
- in: query
@@ -24398,7 +35182,8 @@ paths:
type: array
items:
type: string
- description: Site (slug)
+ format: uuid
+ description: Site (slug or ID)
explode: true
style: form
- in: query
@@ -24408,7 +35193,7 @@ paths:
items:
type: string
format: uuid
- description: Site (ID)
+ description: Site (ID) (deprecated, use "site" filter instead)
explode: true
style: form
- in: query
@@ -24418,7 +35203,7 @@ paths:
items:
type: string
format: uuid
- description: Site (ID)
+ description: Site (ID) (deprecated, use "site" filter instead)
explode: true
style: form
- in: query
@@ -24461,7 +35246,8 @@ paths:
type: array
items:
type: string
- description: Tenant (slug)
+ format: uuid
+ description: Tenant (slug or ID)
explode: true
style: form
- in: query
@@ -24470,7 +35256,8 @@ paths:
type: array
items:
type: string
- description: Tenant (slug)
+ format: uuid
+ description: Tenant (slug or ID)
explode: true
style: form
- in: query
@@ -24521,7 +35308,7 @@ paths:
type: string
format: uuid
nullable: true
- description: Tenant (ID)
+ description: Tenant (ID) (deprecated, use "tenant" filter instead)
explode: true
style: form
- in: query
@@ -24532,7 +35319,7 @@ paths:
type: string
format: uuid
nullable: true
- description: Tenant (ID)
+ description: Tenant (ID) (deprecated, use "tenant" filter instead)
explode: true
style: form
- in: query
@@ -24639,13 +35426,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableRack'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableRack'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableRack'
+ $ref: '#/components/schemas/WritableRackRequest'
required: true
security:
- cookieAuth: []
@@ -24667,13 +35448,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableRack'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableRack'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableRack'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableRackRequest'
required: true
security:
- cookieAuth: []
@@ -24683,7 +35460,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/Rack'
+ type: array
+ items:
+ $ref: '#/components/schemas/Rack'
description: ''
patch:
operationId: dcim_racks_bulk_partial_update
@@ -24695,13 +35474,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableRack'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableRack'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableRack'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableRackRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -24710,7 +35486,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/Rack'
+ type: array
+ items:
+ $ref: '#/components/schemas/Rack'
description: ''
delete:
operationId: dcim_racks_bulk_destroy
@@ -24724,6 +35502,14 @@ paths:
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
@@ -24767,13 +35553,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableRack'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableRack'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableRack'
+ $ref: '#/components/schemas/WritableRackRequest'
required: true
security:
- cookieAuth: []
@@ -24803,13 +35583,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableRack'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableRack'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableRack'
+ $ref: '#/components/schemas/PatchedWritableRackRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -24958,6 +35732,118 @@ paths:
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:
@@ -24977,6 +35863,29 @@ paths:
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:
@@ -25148,6 +36057,21 @@ paths:
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:
@@ -25312,6 +36236,26 @@ paths:
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:
@@ -25534,6 +36478,26 @@ paths:
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:
@@ -25546,7 +36510,7 @@ paths:
items:
type: string
format: uuid
- description: Region (slug)
+ description: Region (slug or ID)
explode: true
style: form
- in: query
@@ -25556,7 +36520,7 @@ paths:
items:
type: string
format: uuid
- description: Region (slug)
+ description: Region (slug or ID)
explode: true
style: form
- in: query
@@ -25566,7 +36530,7 @@ paths:
items:
type: string
format: uuid
- description: Region (ID)
+ description: Region (ID) (deprecated, use "region" filter instead)
explode: true
style: form
- in: query
@@ -25576,7 +36540,7 @@ paths:
items:
type: string
format: uuid
- description: Region (ID)
+ description: Region (ID) (deprecated, use "region" filter instead)
explode: true
style: form
- in: query
@@ -25588,6 +36552,24 @@ paths:
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:
@@ -25638,7 +36620,8 @@ paths:
type: array
items:
type: string
- description: Site (slug)
+ format: uuid
+ description: Site (slug or ID)
explode: true
style: form
- in: query
@@ -25647,7 +36630,8 @@ paths:
type: array
items:
type: string
- description: Site (slug)
+ format: uuid
+ description: Site (slug or ID)
explode: true
style: form
- in: query
@@ -25657,7 +36641,7 @@ paths:
items:
type: string
format: uuid
- description: Site (ID)
+ description: Site (ID) (deprecated, use "site" filter instead)
explode: true
style: form
- in: query
@@ -25667,7 +36651,7 @@ paths:
items:
type: string
format: uuid
- description: Site (ID)
+ description: Site (ID) (deprecated, use "site" filter instead)
explode: true
style: form
- in: query
@@ -25710,7 +36694,8 @@ paths:
type: array
items:
type: string
- description: Tenant (slug)
+ format: uuid
+ description: Tenant (slug or ID)
explode: true
style: form
- in: query
@@ -25719,7 +36704,8 @@ paths:
type: array
items:
type: string
- description: Tenant (slug)
+ format: uuid
+ description: Tenant (slug or ID)
explode: true
style: form
- in: query
@@ -25770,7 +36756,7 @@ paths:
type: string
format: uuid
nullable: true
- description: Tenant (ID)
+ description: Tenant (ID) (deprecated, use "tenant" filter instead)
explode: true
style: form
- in: query
@@ -25781,7 +36767,7 @@ paths:
type: string
format: uuid
nullable: true
- description: Tenant (ID)
+ description: Tenant (ID) (deprecated, use "tenant" filter instead)
explode: true
style: form
- in: query
@@ -25886,12 +36872,225 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -25912,6 +37111,31 @@ paths:
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:
@@ -25919,6 +37143,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -25928,6 +37153,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -25937,6 +37163,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -25946,6 +37173,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -25955,6 +37183,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -25964,6 +37193,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -25973,6 +37203,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -25982,6 +37213,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -25991,6 +37223,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -26000,6 +37233,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -26009,6 +37243,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -26018,6 +37253,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -26027,6 +37263,7 @@ paths:
items:
type: string
format: uuid
+ description: ID
explode: true
style: form
- in: query
@@ -26036,6 +37273,133 @@ paths:
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
@@ -26050,6 +37414,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -26058,6 +37423,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -26066,6 +37432,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -26074,6 +37441,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -26082,6 +37450,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -26090,6 +37459,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -26098,6 +37468,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -26106,6 +37477,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -26114,6 +37486,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -26122,6 +37495,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -26130,6 +37504,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -26138,6 +37513,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -26146,6 +37522,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- in: query
@@ -26154,6 +37531,7 @@ paths:
type: array
items:
type: string
+ description: Name
explode: true
style: form
- name: offset
@@ -26237,21 +37615,17 @@ paths:
description: ''
post:
operationId: dcim_rear_port_templates_create
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritableRearPortTemplate'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableRearPortTemplate'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableRearPortTemplate'
+ $ref: '#/components/schemas/WritableRearPortTemplateRequest'
required: true
security:
- cookieAuth: []
@@ -26265,21 +37639,19 @@ paths:
description: ''
put:
operationId: dcim_rear_port_templates_bulk_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritableRearPortTemplate'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableRearPortTemplate'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableRearPortTemplate'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableRearPortTemplateRequest'
required: true
security:
- cookieAuth: []
@@ -26289,25 +37661,26 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/RearPortTemplate'
+ type: array
+ items:
+ $ref: '#/components/schemas/RearPortTemplate'
description: ''
patch:
operationId: dcim_rear_port_templates_bulk_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/PatchedWritableRearPortTemplate'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableRearPortTemplate'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableRearPortTemplate'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableRearPortTemplateRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -26316,12 +37689,16 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/RearPortTemplate'
+ type: array
+ items:
+ $ref: '#/components/schemas/RearPortTemplate'
description: ''
delete:
operationId: dcim_rear_port_templates_bulk_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -26330,11 +37707,21 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -26357,8 +37744,10 @@ paths:
description: ''
put:
operationId: dcim_rear_port_templates_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -26373,13 +37762,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableRearPortTemplate'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableRearPortTemplate'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableRearPortTemplate'
+ $ref: '#/components/schemas/WritableRearPortTemplateRequest'
required: true
security:
- cookieAuth: []
@@ -26393,8 +37776,10 @@ paths:
description: ''
patch:
operationId: dcim_rear_port_templates_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -26409,13 +37794,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableRearPortTemplate'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableRearPortTemplate'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableRearPortTemplate'
+ $ref: '#/components/schemas/PatchedWritableRearPortTemplateRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -26428,8 +37807,10 @@ paths:
description: ''
delete:
operationId: dcim_rear_port_templates_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -26446,12 +37827,99 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -26608,6 +38076,31 @@ paths:
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:
@@ -26734,6 +38227,118 @@ paths:
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
@@ -27027,21 +38632,17 @@ paths:
description: ''
post:
operationId: dcim_rear_ports_create
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritableRearPort'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableRearPort'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableRearPort'
+ $ref: '#/components/schemas/WritableRearPortRequest'
required: true
security:
- cookieAuth: []
@@ -27055,21 +38656,19 @@ paths:
description: ''
put:
operationId: dcim_rear_ports_bulk_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritableRearPort'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableRearPort'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableRearPort'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableRearPortRequest'
required: true
security:
- cookieAuth: []
@@ -27079,25 +38678,26 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/RearPort'
+ type: array
+ items:
+ $ref: '#/components/schemas/RearPort'
description: ''
patch:
operationId: dcim_rear_ports_bulk_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/PatchedWritableRearPort'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableRearPort'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableRearPort'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableRearPortRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -27106,12 +38706,16 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/RearPort'
+ type: array
+ items:
+ $ref: '#/components/schemas/RearPort'
description: ''
delete:
operationId: dcim_rear_ports_bulk_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -27120,11 +38724,21 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -27147,8 +38761,10 @@ paths:
description: ''
put:
operationId: dcim_rear_ports_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -27163,13 +38779,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableRearPort'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableRearPort'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableRearPort'
+ $ref: '#/components/schemas/WritableRearPortRequest'
required: true
security:
- cookieAuth: []
@@ -27183,8 +38793,10 @@ paths:
description: ''
patch:
operationId: dcim_rear_ports_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -27199,13 +38811,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableRearPort'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableRearPort'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableRearPort'
+ $ref: '#/components/schemas/PatchedWritableRearPortRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -27218,8 +38824,10 @@ paths:
description: ''
delete:
operationId: dcim_rear_ports_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -27236,6 +38844,71 @@ paths:
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
@@ -27263,9 +38936,31 @@ paths:
/dcim/regions/:
get:
operationId: dcim_regions_list
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -27393,6 +39088,16 @@ paths:
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:
@@ -27703,6 +39408,26 @@ paths:
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:
@@ -27829,21 +39554,17 @@ paths:
description: ''
post:
operationId: dcim_regions_create
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritableRegion'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableRegion'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableRegion'
+ $ref: '#/components/schemas/WritableRegionRequest'
required: true
security:
- cookieAuth: []
@@ -27857,21 +39578,19 @@ paths:
description: ''
put:
operationId: dcim_regions_bulk_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritableRegion'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableRegion'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableRegion'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableRegionRequest'
required: true
security:
- cookieAuth: []
@@ -27881,25 +39600,26 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/Region'
+ type: array
+ items:
+ $ref: '#/components/schemas/Region'
description: ''
patch:
operationId: dcim_regions_bulk_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/PatchedWritableRegion'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableRegion'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableRegion'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableRegionRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -27908,12 +39628,16 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/Region'
+ type: array
+ items:
+ $ref: '#/components/schemas/Region'
description: ''
delete:
operationId: dcim_regions_bulk_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -27922,11 +39646,21 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -27949,8 +39683,10 @@ paths:
description: ''
put:
operationId: dcim_regions_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -27965,13 +39701,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableRegion'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableRegion'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableRegion'
+ $ref: '#/components/schemas/WritableRegionRequest'
required: true
security:
- cookieAuth: []
@@ -27985,8 +39715,10 @@ paths:
description: ''
patch:
operationId: dcim_regions_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -28001,13 +39733,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableRegion'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableRegion'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableRegion'
+ $ref: '#/components/schemas/PatchedWritableRegionRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -28020,8 +39746,10 @@ paths:
description: ''
delete:
operationId: dcim_regions_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -28038,6 +39766,71 @@ paths:
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
@@ -28092,6 +39885,154 @@ paths:
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:
@@ -28443,6 +40384,138 @@ paths:
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:
@@ -28555,6 +40628,56 @@ paths:
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:
@@ -28750,6 +40873,26 @@ paths:
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:
@@ -28916,11 +41059,199 @@ paths:
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:
@@ -28961,6 +41292,118 @@ paths:
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:
@@ -29113,7 +41556,8 @@ paths:
type: array
items:
type: string
- description: Tenant (slug)
+ format: uuid
+ description: Tenant (slug or ID)
explode: true
style: form
- in: query
@@ -29122,7 +41566,8 @@ paths:
type: array
items:
type: string
- description: Tenant (slug)
+ format: uuid
+ description: Tenant (slug or ID)
explode: true
style: form
- in: query
@@ -29173,7 +41618,7 @@ paths:
type: string
format: uuid
nullable: true
- description: Tenant (ID)
+ description: Tenant (ID) (deprecated, use "tenant" filter instead)
explode: true
style: form
- in: query
@@ -29184,7 +41629,931 @@ paths:
type: string
format: uuid
nullable: true
- description: Tenant (ID)
+ 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:
@@ -29209,13 +42578,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableSite'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableSite'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableSite'
+ $ref: '#/components/schemas/WritableSiteRequest'
required: true
security:
- cookieAuth: []
@@ -29237,13 +42600,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableSite'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableSite'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableSite'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableSiteRequest'
required: true
security:
- cookieAuth: []
@@ -29253,7 +42612,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/Site'
+ type: array
+ items:
+ $ref: '#/components/schemas/Site'
description: ''
patch:
operationId: dcim_sites_bulk_partial_update
@@ -29265,13 +42626,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableSite'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableSite'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableSite'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableSiteRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -29280,7 +42638,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/Site'
+ type: array
+ items:
+ $ref: '#/components/schemas/Site'
description: ''
delete:
operationId: dcim_sites_bulk_destroy
@@ -29294,6 +42654,14 @@ paths:
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
@@ -29337,13 +42705,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableSite'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableSite'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableSite'
+ $ref: '#/components/schemas/WritableSiteRequest'
required: true
security:
- cookieAuth: []
@@ -29373,13 +42735,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableSite'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableSite'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableSite'
+ $ref: '#/components/schemas/PatchedWritableSiteRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -29410,10 +42766,78 @@ paths:
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: Extend DRF's ModelViewSet to support bulk update and delete functions.
+ description: |-
+ Base class to 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
@@ -29542,6 +42966,11 @@ paths:
type: string
explode: true
style: form
+ - in: query
+ name: has_members
+ schema:
+ type: boolean
+ description: Has device members
- in: query
name: id
schema:
@@ -29731,6 +43160,26 @@ paths:
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:
@@ -30000,20 +43449,17 @@ paths:
description: ''
post:
operationId: dcim_virtual_chassis_create
- description: Extend DRF's ModelViewSet to support bulk update and delete functions.
+ description: |-
+ Base class to 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/WritableVirtualChassis'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableVirtualChassis'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableVirtualChassis'
+ $ref: '#/components/schemas/WritableVirtualChassisRequest'
required: true
security:
- cookieAuth: []
@@ -30027,20 +43473,19 @@ paths:
description: ''
put:
operationId: dcim_virtual_chassis_bulk_update
- description: Extend DRF's ModelViewSet to support bulk update and delete functions.
+ description: |-
+ Base class to 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/WritableVirtualChassis'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableVirtualChassis'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableVirtualChassis'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableVirtualChassisRequest'
required: true
security:
- cookieAuth: []
@@ -30050,24 +43495,26 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/VirtualChassis'
+ type: array
+ items:
+ $ref: '#/components/schemas/VirtualChassis'
description: ''
patch:
operationId: dcim_virtual_chassis_bulk_partial_update
- description: Extend DRF's ModelViewSet to support bulk update and delete functions.
+ description: |-
+ Base class to 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/PatchedWritableVirtualChassis'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableVirtualChassis'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableVirtualChassis'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableVirtualChassisRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -30076,11 +43523,16 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/VirtualChassis'
+ type: array
+ items:
+ $ref: '#/components/schemas/VirtualChassis'
description: ''
delete:
operationId: dcim_virtual_chassis_bulk_destroy
- description: Extend DRF's ModelViewSet to support bulk update and delete functions.
+ description: |-
+ Base class to 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:
@@ -30089,10 +43541,21 @@ paths:
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: Extend DRF's ModelViewSet to support bulk update and delete functions.
+ description: |-
+ Base class to 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
@@ -30115,7 +43578,10 @@ paths:
description: ''
put:
operationId: dcim_virtual_chassis_update
- description: Extend DRF's ModelViewSet to support bulk update and delete functions.
+ description: |-
+ Base class to 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
@@ -30130,13 +43596,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableVirtualChassis'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableVirtualChassis'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableVirtualChassis'
+ $ref: '#/components/schemas/WritableVirtualChassisRequest'
required: true
security:
- cookieAuth: []
@@ -30150,7 +43610,10 @@ paths:
description: ''
patch:
operationId: dcim_virtual_chassis_partial_update
- description: Extend DRF's ModelViewSet to support bulk update and delete functions.
+ description: |-
+ Base class to 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
@@ -30165,13 +43628,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableVirtualChassis'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableVirtualChassis'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableVirtualChassis'
+ $ref: '#/components/schemas/PatchedWritableVirtualChassisRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -30184,7 +43641,10 @@ paths:
description: ''
delete:
operationId: dcim_virtual_chassis_destroy
- description: Extend DRF's ModelViewSet to support bulk update and delete functions.
+ description: |-
+ Base class to 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
@@ -30201,6 +43661,71 @@ paths:
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
@@ -30327,6 +43852,132 @@ paths:
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
@@ -30638,13 +44289,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/ComputedField'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/ComputedField'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/ComputedField'
+ $ref: '#/components/schemas/ComputedFieldRequest'
required: true
security:
- cookieAuth: []
@@ -30666,13 +44311,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/ComputedField'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/ComputedField'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/ComputedField'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableComputedFieldRequest'
required: true
security:
- cookieAuth: []
@@ -30682,7 +44323,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/ComputedField'
+ type: array
+ items:
+ $ref: '#/components/schemas/ComputedField'
description: ''
patch:
operationId: extras_computed_fields_bulk_partial_update
@@ -30694,13 +44337,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedComputedField'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedComputedField'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedComputedField'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableComputedFieldRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -30709,7 +44349,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/ComputedField'
+ type: array
+ items:
+ $ref: '#/components/schemas/ComputedField'
description: ''
delete:
operationId: extras_computed_fields_bulk_destroy
@@ -30723,6 +44365,14 @@ paths:
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
@@ -30766,13 +44416,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/ComputedField'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/ComputedField'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/ComputedField'
+ $ref: '#/components/schemas/ComputedFieldRequest'
required: true
security:
- cookieAuth: []
@@ -30802,13 +44446,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedComputedField'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedComputedField'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedComputedField'
+ $ref: '#/components/schemas/PatchedComputedFieldRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -30839,6 +44477,71 @@ paths:
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
@@ -31240,13 +44943,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/ConfigContextSchema'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/ConfigContextSchema'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/ConfigContextSchema'
+ $ref: '#/components/schemas/ConfigContextSchemaRequest'
required: true
security:
- cookieAuth: []
@@ -31267,13 +44964,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/ConfigContextSchema'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/ConfigContextSchema'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/ConfigContextSchema'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableConfigContextSchemaRequest'
required: true
security:
- cookieAuth: []
@@ -31283,7 +44976,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/ConfigContextSchema'
+ type: array
+ items:
+ $ref: '#/components/schemas/ConfigContextSchema'
description: ''
patch:
operationId: extras_config_context_schemas_bulk_partial_update
@@ -31294,13 +44989,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedConfigContextSchema'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedConfigContextSchema'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedConfigContextSchema'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableConfigContextSchemaRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -31309,7 +45001,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/ConfigContextSchema'
+ type: array
+ items:
+ $ref: '#/components/schemas/ConfigContextSchema'
description: ''
delete:
operationId: extras_config_context_schemas_bulk_destroy
@@ -31322,6 +45016,14 @@ paths:
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
@@ -31363,13 +45065,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/ConfigContextSchema'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/ConfigContextSchema'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/ConfigContextSchema'
+ $ref: '#/components/schemas/ConfigContextSchemaRequest'
required: true
security:
- cookieAuth: []
@@ -31398,13 +45094,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedConfigContextSchema'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedConfigContextSchema'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedConfigContextSchema'
+ $ref: '#/components/schemas/PatchedConfigContextSchemaRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -31434,6 +45124,71 @@ paths:
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
@@ -31497,6 +45252,26 @@ paths:
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:
@@ -31671,6 +45446,44 @@ paths:
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:
@@ -32042,6 +45855,26 @@ paths:
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:
@@ -32195,13 +46028,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableConfigContext'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableConfigContext'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableConfigContext'
+ $ref: '#/components/schemas/WritableConfigContextRequest'
required: true
security:
- cookieAuth: []
@@ -32222,13 +46049,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableConfigContext'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableConfigContext'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableConfigContext'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableConfigContextRequest'
required: true
security:
- cookieAuth: []
@@ -32238,7 +46061,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/ConfigContext'
+ type: array
+ items:
+ $ref: '#/components/schemas/ConfigContext'
description: ''
patch:
operationId: extras_config_contexts_bulk_partial_update
@@ -32249,13 +46074,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableConfigContext'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableConfigContext'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableConfigContext'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableConfigContextRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -32264,7 +46086,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/ConfigContext'
+ type: array
+ items:
+ $ref: '#/components/schemas/ConfigContext'
description: ''
delete:
operationId: extras_config_contexts_bulk_destroy
@@ -32277,6 +46101,14 @@ paths:
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
@@ -32318,13 +46150,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableConfigContext'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableConfigContext'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableConfigContext'
+ $ref: '#/components/schemas/WritableConfigContextRequest'
required: true
security:
- cookieAuth: []
@@ -32353,13 +46179,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableConfigContext'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableConfigContext'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableConfigContext'
+ $ref: '#/components/schemas/PatchedWritableConfigContextRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -32389,6 +46209,71 @@ paths:
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
@@ -32398,11 +46283,163 @@ paths:
- in: query
name: app_label
schema:
- type: string
+ 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: integer
+ 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
@@ -32412,13 +46449,126 @@ paths:
- in: query
name: model
schema:
- type: string
+ 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:
@@ -32466,7 +46616,6 @@ paths:
type: array
items:
type: string
- title: Slug
description: Field (name)
explode: true
style: form
@@ -32476,7 +46625,6 @@ paths:
type: array
items:
type: string
- title: Slug
description: Field (name)
explode: true
style: form
@@ -32824,13 +46972,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableCustomFieldChoice'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableCustomFieldChoice'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableCustomFieldChoice'
+ $ref: '#/components/schemas/WritableCustomFieldChoiceRequest'
required: true
security:
- cookieAuth: []
@@ -32851,13 +46993,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableCustomFieldChoice'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableCustomFieldChoice'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableCustomFieldChoice'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableCustomFieldChoiceRequest'
required: true
security:
- cookieAuth: []
@@ -32867,7 +47005,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/CustomFieldChoice'
+ type: array
+ items:
+ $ref: '#/components/schemas/CustomFieldChoice'
description: ''
patch:
operationId: extras_custom_field_choices_bulk_partial_update
@@ -32878,13 +47018,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableCustomFieldChoice'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableCustomFieldChoice'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableCustomFieldChoice'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableCustomFieldChoiceRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -32893,7 +47030,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/CustomFieldChoice'
+ type: array
+ items:
+ $ref: '#/components/schemas/CustomFieldChoice'
description: ''
delete:
operationId: extras_custom_field_choices_bulk_destroy
@@ -32906,6 +47045,14 @@ paths:
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
@@ -32947,13 +47094,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableCustomFieldChoice'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableCustomFieldChoice'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableCustomFieldChoice'
+ $ref: '#/components/schemas/WritableCustomFieldChoiceRequest'
required: true
security:
- cookieAuth: []
@@ -32982,13 +47123,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableCustomFieldChoice'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableCustomFieldChoice'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableCustomFieldChoice'
+ $ref: '#/components/schemas/PatchedWritableCustomFieldChoiceRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -33368,7 +47503,7 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/PaginatedCustomFieldList'
+ $ref: '#/components/schemas/PaginatedCustomFieldSerializerVersion12List'
description: ''
post:
operationId: extras_custom_fields_create
@@ -33379,13 +47514,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableCustomField'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableCustomField'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableCustomField'
+ $ref: '#/components/schemas/CustomFieldSerializerVersion12Request'
required: true
security:
- cookieAuth: []
@@ -33395,7 +47524,7 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/CustomField'
+ $ref: '#/components/schemas/CustomFieldSerializerVersion12'
description: ''
put:
operationId: extras_custom_fields_bulk_update
@@ -33406,13 +47535,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableCustomField'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableCustomField'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableCustomField'
+ type: array
+ items:
+ $ref: '#/components/schemas/CustomFieldSerializerVersion12Request'
required: true
security:
- cookieAuth: []
@@ -33422,7 +47547,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/CustomField'
+ type: array
+ items:
+ $ref: '#/components/schemas/CustomFieldSerializerVersion12'
description: ''
patch:
operationId: extras_custom_fields_bulk_partial_update
@@ -33433,13 +47560,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableCustomField'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableCustomField'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableCustomField'
+ type: array
+ items:
+ $ref: '#/components/schemas/CustomFieldSerializerVersion12Request'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -33448,7 +47572,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/CustomField'
+ type: array
+ items:
+ $ref: '#/components/schemas/CustomFieldSerializerVersion12'
description: ''
delete:
operationId: extras_custom_fields_bulk_destroy
@@ -33461,6 +47587,14 @@ paths:
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
@@ -33483,7 +47617,7 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/CustomField'
+ $ref: '#/components/schemas/CustomFieldSerializerVersion12'
description: ''
put:
operationId: extras_custom_fields_update
@@ -33502,13 +47636,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableCustomField'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableCustomField'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableCustomField'
+ $ref: '#/components/schemas/CustomFieldSerializerVersion12Request'
required: true
security:
- cookieAuth: []
@@ -33518,7 +47646,7 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/CustomField'
+ $ref: '#/components/schemas/CustomFieldSerializerVersion12'
description: ''
patch:
operationId: extras_custom_fields_partial_update
@@ -33537,13 +47665,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableCustomField'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableCustomField'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableCustomField'
+ $ref: '#/components/schemas/PatchedCustomFieldSerializerVersion12Request'
security:
- cookieAuth: []
- tokenAuth: []
@@ -33552,7 +47674,7 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/CustomField'
+ $ref: '#/components/schemas/CustomFieldSerializerVersion12'
description: ''
delete:
operationId: extras_custom_fields_destroy
@@ -33573,6 +47695,71 @@ paths:
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
@@ -33710,6 +47897,132 @@ paths:
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
@@ -34136,13 +48449,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/CustomLink'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/CustomLink'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/CustomLink'
+ $ref: '#/components/schemas/CustomLinkRequest'
required: true
security:
- cookieAuth: []
@@ -34163,13 +48470,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/CustomLink'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/CustomLink'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/CustomLink'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableCustomLinkRequest'
required: true
security:
- cookieAuth: []
@@ -34179,7 +48482,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/CustomLink'
+ type: array
+ items:
+ $ref: '#/components/schemas/CustomLink'
description: ''
patch:
operationId: extras_custom_links_bulk_partial_update
@@ -34190,13 +48495,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedCustomLink'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedCustomLink'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedCustomLink'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableCustomLinkRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -34205,7 +48507,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/CustomLink'
+ type: array
+ items:
+ $ref: '#/components/schemas/CustomLink'
description: ''
delete:
operationId: extras_custom_links_bulk_destroy
@@ -34218,6 +48522,14 @@ paths:
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
@@ -34259,13 +48571,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/CustomLink'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/CustomLink'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/CustomLink'
+ $ref: '#/components/schemas/CustomLinkRequest'
required: true
security:
- cookieAuth: []
@@ -34294,13 +48600,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedCustomLink'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedCustomLink'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedCustomLink'
+ $ref: '#/components/schemas/PatchedCustomLinkRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -34330,6 +48630,564 @@ paths:
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
@@ -34883,13 +49741,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/DynamicGroup'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/DynamicGroup'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/DynamicGroup'
+ $ref: '#/components/schemas/DynamicGroupRequest'
required: true
security:
- cookieAuth: []
@@ -34911,13 +49763,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/DynamicGroup'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/DynamicGroup'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/DynamicGroup'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableDynamicGroupRequest'
required: true
security:
- cookieAuth: []
@@ -34927,7 +49775,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/DynamicGroup'
+ type: array
+ items:
+ $ref: '#/components/schemas/DynamicGroup'
description: ''
patch:
operationId: extras_dynamic_groups_bulk_partial_update
@@ -34939,13 +49789,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedDynamicGroup'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedDynamicGroup'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedDynamicGroup'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableDynamicGroupRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -34954,7 +49801,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/DynamicGroup'
+ type: array
+ items:
+ $ref: '#/components/schemas/DynamicGroup'
description: ''
delete:
operationId: extras_dynamic_groups_bulk_destroy
@@ -34968,6 +49817,14 @@ paths:
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
@@ -35011,13 +49868,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/DynamicGroup'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/DynamicGroup'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/DynamicGroup'
+ $ref: '#/components/schemas/DynamicGroupRequest'
required: true
security:
- cookieAuth: []
@@ -35047,13 +49898,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedDynamicGroup'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedDynamicGroup'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedDynamicGroup'
+ $ref: '#/components/schemas/PatchedDynamicGroupRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -35109,6 +49954,71 @@ paths:
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
@@ -35532,13 +50442,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/ExportTemplate'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/ExportTemplate'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/ExportTemplate'
+ $ref: '#/components/schemas/ExportTemplateRequest'
required: true
security:
- cookieAuth: []
@@ -35559,13 +50463,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/ExportTemplate'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/ExportTemplate'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/ExportTemplate'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableExportTemplateRequest'
required: true
security:
- cookieAuth: []
@@ -35575,7 +50475,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/ExportTemplate'
+ type: array
+ items:
+ $ref: '#/components/schemas/ExportTemplate'
description: ''
patch:
operationId: extras_export_templates_bulk_partial_update
@@ -35586,13 +50488,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedExportTemplate'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedExportTemplate'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedExportTemplate'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableExportTemplateRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -35601,7 +50500,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/ExportTemplate'
+ type: array
+ items:
+ $ref: '#/components/schemas/ExportTemplate'
description: ''
delete:
operationId: extras_export_templates_bulk_destroy
@@ -35614,6 +50515,14 @@ paths:
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
@@ -35655,13 +50564,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/ExportTemplate'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/ExportTemplate'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/ExportTemplate'
+ $ref: '#/components/schemas/ExportTemplateRequest'
required: true
security:
- cookieAuth: []
@@ -35690,13 +50593,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedExportTemplate'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedExportTemplate'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedExportTemplate'
+ $ref: '#/components/schemas/PatchedExportTemplateRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -35726,6 +50623,71 @@ paths:
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
@@ -36123,6 +51085,14 @@ paths:
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:
@@ -36427,13 +51397,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableGitRepository'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableGitRepository'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableGitRepository'
+ $ref: '#/components/schemas/WritableGitRepositoryRequest'
required: true
security:
- cookieAuth: []
@@ -36454,13 +51418,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableGitRepository'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableGitRepository'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableGitRepository'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableGitRepositoryRequest'
required: true
security:
- cookieAuth: []
@@ -36470,7 +51430,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/GitRepository'
+ type: array
+ items:
+ $ref: '#/components/schemas/GitRepository'
description: ''
patch:
operationId: extras_git_repositories_bulk_partial_update
@@ -36481,13 +51443,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableGitRepository'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableGitRepository'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableGitRepository'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableGitRepositoryRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -36496,7 +51455,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/GitRepository'
+ type: array
+ items:
+ $ref: '#/components/schemas/GitRepository'
description: ''
delete:
operationId: extras_git_repositories_bulk_destroy
@@ -36509,6 +51470,14 @@ paths:
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
@@ -36550,13 +51519,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableGitRepository'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableGitRepository'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableGitRepository'
+ $ref: '#/components/schemas/WritableGitRepositoryRequest'
required: true
security:
- cookieAuth: []
@@ -36585,13 +51548,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableGitRepository'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableGitRepository'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableGitRepository'
+ $ref: '#/components/schemas/PatchedWritableGitRepositoryRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -36621,6 +51578,71 @@ paths:
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
@@ -36639,13 +51661,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/GitRepository'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/GitRepository'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/GitRepository'
+ $ref: '#/components/schemas/GitRepositoryRequest'
required: true
security:
- cookieAuth: []
@@ -36662,6 +51678,132 @@ paths:
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
@@ -36924,13 +52066,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/GraphQLQuery'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/GraphQLQuery'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/GraphQLQuery'
+ $ref: '#/components/schemas/GraphQLQueryRequest'
required: true
security:
- cookieAuth: []
@@ -36951,13 +52087,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/GraphQLQuery'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/GraphQLQuery'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/GraphQLQuery'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableGraphQLQueryRequest'
required: true
security:
- cookieAuth: []
@@ -36967,7 +52099,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/GraphQLQuery'
+ type: array
+ items:
+ $ref: '#/components/schemas/GraphQLQuery'
description: ''
patch:
operationId: extras_graphql_queries_bulk_partial_update
@@ -36978,13 +52112,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedGraphQLQuery'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedGraphQLQuery'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedGraphQLQuery'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableGraphQLQueryRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -36993,7 +52124,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/GraphQLQuery'
+ type: array
+ items:
+ $ref: '#/components/schemas/GraphQLQuery'
description: ''
delete:
operationId: extras_graphql_queries_bulk_destroy
@@ -37006,6 +52139,14 @@ paths:
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
@@ -37047,13 +52188,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/GraphQLQuery'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/GraphQLQuery'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/GraphQLQuery'
+ $ref: '#/components/schemas/GraphQLQueryRequest'
required: true
security:
- cookieAuth: []
@@ -37082,13 +52217,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedGraphQLQuery'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedGraphQLQuery'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedGraphQLQuery'
+ $ref: '#/components/schemas/PatchedGraphQLQueryRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -37118,6 +52247,71 @@ paths:
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
@@ -37136,13 +52330,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/GraphQLQueryInput'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/GraphQLQueryInput'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/GraphQLQueryInput'
+ $ref: '#/components/schemas/GraphQLQueryInputRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -37571,13 +52759,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/ImageAttachment'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/ImageAttachment'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/ImageAttachment'
+ $ref: '#/components/schemas/ImageAttachmentRequest'
required: true
security:
- cookieAuth: []
@@ -37598,13 +52780,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/ImageAttachment'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/ImageAttachment'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/ImageAttachment'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableImageAttachmentRequest'
required: true
security:
- cookieAuth: []
@@ -37614,7 +52792,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/ImageAttachment'
+ type: array
+ items:
+ $ref: '#/components/schemas/ImageAttachment'
description: ''
patch:
operationId: extras_image_attachments_bulk_partial_update
@@ -37625,13 +52805,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedImageAttachment'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedImageAttachment'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedImageAttachment'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableImageAttachmentRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -37640,7 +52817,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/ImageAttachment'
+ type: array
+ items:
+ $ref: '#/components/schemas/ImageAttachment'
description: ''
delete:
operationId: extras_image_attachments_bulk_destroy
@@ -37653,6 +52832,14 @@ paths:
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
@@ -37694,13 +52881,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/ImageAttachment'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/ImageAttachment'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/ImageAttachment'
+ $ref: '#/components/schemas/ImageAttachmentRequest'
required: true
security:
- cookieAuth: []
@@ -37729,13 +52910,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedImageAttachment'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedImageAttachment'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedImageAttachment'
+ $ref: '#/components/schemas/PatchedImageAttachmentRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -37765,6 +52940,697 @@ paths:
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
@@ -38825,86 +54691,6 @@ paths:
schema:
$ref: '#/components/schemas/PaginatedJobResultList'
description: ''
- post:
- operationId: extras_job_results_create
- description: Retrieve a list of job results
- tags:
- - extras
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/JobResult'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/JobResult'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/JobResult'
- required: true
- security:
- - cookieAuth: []
- - tokenAuth: []
- responses:
- '201':
- content:
- application/json; version=1.3:
- schema:
- $ref: '#/components/schemas/JobResult'
- description: ''
- put:
- operationId: extras_job_results_bulk_update
- description: Retrieve a list of job results
- tags:
- - extras
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/JobResult'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/JobResult'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/JobResult'
- required: true
- security:
- - cookieAuth: []
- - tokenAuth: []
- responses:
- '200':
- content:
- application/json; version=1.3:
- schema:
- $ref: '#/components/schemas/JobResult'
- description: ''
- patch:
- operationId: extras_job_results_bulk_partial_update
- description: Retrieve a list of job results
- tags:
- - extras
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/PatchedJobResult'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedJobResult'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedJobResult'
- security:
- - cookieAuth: []
- - tokenAuth: []
- responses:
- '200':
- content:
- application/json; version=1.3:
- schema:
- $ref: '#/components/schemas/JobResult'
- description: ''
delete:
operationId: extras_job_results_bulk_destroy
description: Retrieve a list of job results
@@ -38916,6 +54702,14 @@ paths:
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
@@ -38940,75 +54734,6 @@ paths:
schema:
$ref: '#/components/schemas/JobResult'
description: ''
- put:
- operationId: extras_job_results_update
- description: Retrieve a list of job results
- parameters:
- - in: path
- name: id
- schema:
- type: string
- format: uuid
- description: A UUID string identifying this job result.
- required: true
- tags:
- - extras
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/JobResult'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/JobResult'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/JobResult'
- required: true
- security:
- - cookieAuth: []
- - tokenAuth: []
- responses:
- '200':
- content:
- application/json; version=1.3:
- schema:
- $ref: '#/components/schemas/JobResult'
- description: ''
- patch:
- operationId: extras_job_results_partial_update
- description: Retrieve a list of job results
- parameters:
- - in: path
- name: id
- schema:
- type: string
- format: uuid
- description: A UUID string identifying this job result.
- required: true
- tags:
- - extras
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/PatchedJobResult'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedJobResult'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedJobResult'
- security:
- - cookieAuth: []
- - tokenAuth: []
- responses:
- '200':
- content:
- application/json; version=1.3:
- schema:
- $ref: '#/components/schemas/JobResult'
- description: ''
delete:
operationId: extras_job_results_destroy
description: Retrieve a list of job results
@@ -39197,6 +54922,14 @@ paths:
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:
@@ -39335,6 +55068,10 @@ paths:
name: installed
schema:
type: boolean
+ - in: query
+ name: is_job_hook_receiver
+ schema:
+ type: boolean
- in: query
name: job_class_name
schema:
@@ -39976,13 +55713,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Job'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/Job'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/Job'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableJobRequest'
required: true
security:
- cookieAuth: []
@@ -39992,7 +55725,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/Job'
+ type: array
+ items:
+ $ref: '#/components/schemas/Job'
description: ''
patch:
operationId: extras_jobs_bulk_partial_update
@@ -40002,13 +55737,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedJob'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedJob'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedJob'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableJobRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -40017,7 +55749,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/Job'
+ type: array
+ items:
+ $ref: '#/components/schemas/Job'
description: ''
delete:
operationId: extras_jobs_bulk_destroy
@@ -40029,6 +55763,14 @@ paths:
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
@@ -40076,13 +55818,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/JobInput'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/JobInput'
+ $ref: '#/components/schemas/JobInputRequest'
multipart/form-data:
schema:
- $ref: '#/components/schemas/JobInput'
+ $ref: '#/components/schemas/JobInputRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -40133,13 +55872,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Job'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/Job'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/Job'
+ $ref: '#/components/schemas/JobRequest'
required: true
security:
- cookieAuth: []
@@ -40167,13 +55900,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedJob'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedJob'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedJob'
+ $ref: '#/components/schemas/PatchedJobRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -40202,6 +55929,71 @@ paths:
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
@@ -40220,13 +56012,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/JobInput'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/JobInput'
+ $ref: '#/components/schemas/JobInputRequest'
multipart/form-data:
schema:
- $ref: '#/components/schemas/JobInput'
+ $ref: '#/components/schemas/JobMultiPartInputRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -40274,6 +56063,742 @@ paths:
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
@@ -41337,6 +57862,15 @@ paths:
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:
@@ -41518,13 +58052,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableRelationshipAssociation'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableRelationshipAssociation'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableRelationshipAssociation'
+ $ref: '#/components/schemas/WritableRelationshipAssociationRequest'
required: true
security:
- cookieAuth: []
@@ -41545,13 +58073,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableRelationshipAssociation'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableRelationshipAssociation'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableRelationshipAssociation'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableRelationshipAssociationRequest'
required: true
security:
- cookieAuth: []
@@ -41561,7 +58085,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/RelationshipAssociation'
+ type: array
+ items:
+ $ref: '#/components/schemas/RelationshipAssociation'
description: ''
patch:
operationId: extras_relationship_associations_bulk_partial_update
@@ -41572,13 +58098,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableRelationshipAssociation'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableRelationshipAssociation'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableRelationshipAssociation'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableRelationshipAssociationRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -41587,7 +58110,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/RelationshipAssociation'
+ type: array
+ items:
+ $ref: '#/components/schemas/RelationshipAssociation'
description: ''
delete:
operationId: extras_relationship_associations_bulk_destroy
@@ -41600,6 +58125,14 @@ paths:
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
@@ -41641,13 +58174,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableRelationshipAssociation'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableRelationshipAssociation'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableRelationshipAssociation'
+ $ref: '#/components/schemas/WritableRelationshipAssociationRequest'
required: true
security:
- cookieAuth: []
@@ -41676,13 +58203,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableRelationshipAssociation'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableRelationshipAssociation'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableRelationshipAssociation'
+ $ref: '#/components/schemas/PatchedWritableRelationshipAssociationRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -41983,6 +58504,123 @@ paths:
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:
@@ -42030,13 +58668,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Relationship'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/Relationship'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/Relationship'
+ $ref: '#/components/schemas/RelationshipRequest'
required: true
security:
- cookieAuth: []
@@ -42057,13 +58689,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Relationship'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/Relationship'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/Relationship'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableRelationshipRequest'
required: true
security:
- cookieAuth: []
@@ -42073,7 +58701,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/Relationship'
+ type: array
+ items:
+ $ref: '#/components/schemas/Relationship'
description: ''
patch:
operationId: extras_relationships_bulk_partial_update
@@ -42084,13 +58714,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedRelationship'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedRelationship'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedRelationship'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableRelationshipRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -42099,7 +58726,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/Relationship'
+ type: array
+ items:
+ $ref: '#/components/schemas/Relationship'
description: ''
delete:
operationId: extras_relationships_bulk_destroy
@@ -42112,6 +58741,14 @@ paths:
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
@@ -42153,13 +58790,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Relationship'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/Relationship'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/Relationship'
+ $ref: '#/components/schemas/RelationshipRequest'
required: true
security:
- cookieAuth: []
@@ -42188,13 +58819,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedRelationship'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedRelationship'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedRelationship'
+ $ref: '#/components/schemas/PatchedRelationshipRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -42224,6 +58849,71 @@ paths:
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
@@ -43230,13 +59920,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Secret'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/Secret'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/Secret'
+ $ref: '#/components/schemas/SecretRequest'
required: true
security:
- cookieAuth: []
@@ -43257,13 +59941,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Secret'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/Secret'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/Secret'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableSecretRequest'
required: true
security:
- cookieAuth: []
@@ -43273,7 +59953,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/Secret'
+ type: array
+ items:
+ $ref: '#/components/schemas/Secret'
description: ''
patch:
operationId: extras_secrets_bulk_partial_update
@@ -43284,13 +59966,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedSecret'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedSecret'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedSecret'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableSecretRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -43299,7 +59978,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/Secret'
+ type: array
+ items:
+ $ref: '#/components/schemas/Secret'
description: ''
delete:
operationId: extras_secrets_bulk_destroy
@@ -43312,6 +59993,14 @@ paths:
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
@@ -43737,13 +60426,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/SecretsGroup'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/SecretsGroup'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/SecretsGroup'
+ $ref: '#/components/schemas/SecretsGroupRequest'
required: true
security:
- cookieAuth: []
@@ -43765,13 +60448,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/SecretsGroup'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/SecretsGroup'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/SecretsGroup'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableSecretsGroupRequest'
required: true
security:
- cookieAuth: []
@@ -43781,7 +60460,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/SecretsGroup'
+ type: array
+ items:
+ $ref: '#/components/schemas/SecretsGroup'
description: ''
patch:
operationId: extras_secrets_groups_bulk_partial_update
@@ -43793,13 +60474,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedSecretsGroup'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedSecretsGroup'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedSecretsGroup'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableSecretsGroupRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -43808,7 +60486,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/SecretsGroup'
+ type: array
+ items:
+ $ref: '#/components/schemas/SecretsGroup'
description: ''
delete:
operationId: extras_secrets_groups_bulk_destroy
@@ -43822,6 +60502,14 @@ paths:
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
@@ -44096,13 +60784,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableSecretsGroupAssociation'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableSecretsGroupAssociation'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableSecretsGroupAssociation'
+ $ref: '#/components/schemas/WritableSecretsGroupAssociationRequest'
required: true
security:
- cookieAuth: []
@@ -44124,13 +60806,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableSecretsGroupAssociation'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableSecretsGroupAssociation'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableSecretsGroupAssociation'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableSecretsGroupAssociationRequest'
required: true
security:
- cookieAuth: []
@@ -44140,7 +60818,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/SecretsGroupAssociation'
+ type: array
+ items:
+ $ref: '#/components/schemas/SecretsGroupAssociation'
description: ''
patch:
operationId: extras_secrets_groups_associations_bulk_partial_update
@@ -44152,13 +60832,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableSecretsGroupAssociation'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableSecretsGroupAssociation'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableSecretsGroupAssociation'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableSecretsGroupAssociationRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -44167,7 +60844,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/SecretsGroupAssociation'
+ type: array
+ items:
+ $ref: '#/components/schemas/SecretsGroupAssociation'
description: ''
delete:
operationId: extras_secrets_groups_associations_bulk_destroy
@@ -44181,6 +60860,14 @@ paths:
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
@@ -44224,13 +60911,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableSecretsGroupAssociation'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableSecretsGroupAssociation'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableSecretsGroupAssociation'
+ $ref: '#/components/schemas/WritableSecretsGroupAssociationRequest'
required: true
security:
- cookieAuth: []
@@ -44260,13 +60941,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableSecretsGroupAssociation'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableSecretsGroupAssociation'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableSecretsGroupAssociation'
+ $ref: '#/components/schemas/PatchedWritableSecretsGroupAssociationRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -44340,13 +61015,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/SecretsGroup'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/SecretsGroup'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/SecretsGroup'
+ $ref: '#/components/schemas/SecretsGroupRequest'
required: true
security:
- cookieAuth: []
@@ -44376,13 +61045,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedSecretsGroup'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedSecretsGroup'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedSecretsGroup'
+ $ref: '#/components/schemas/PatchedSecretsGroupRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -44413,6 +61076,71 @@ paths:
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
@@ -44454,13 +61182,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Secret'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/Secret'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/Secret'
+ $ref: '#/components/schemas/SecretRequest'
required: true
security:
- cookieAuth: []
@@ -44489,13 +61211,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedSecret'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedSecret'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedSecret'
+ $ref: '#/components/schemas/PatchedSecretRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -44525,6 +61241,71 @@ paths:
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
@@ -45078,13 +61859,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Status'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/Status'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/Status'
+ $ref: '#/components/schemas/StatusRequest'
required: true
security:
- cookieAuth: []
@@ -45106,13 +61881,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Status'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/Status'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/Status'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableStatusRequest'
required: true
security:
- cookieAuth: []
@@ -45122,7 +61893,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/Status'
+ type: array
+ items:
+ $ref: '#/components/schemas/Status'
description: ''
patch:
operationId: extras_statuses_bulk_partial_update
@@ -45134,13 +61907,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedStatus'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedStatus'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedStatus'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableStatusRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -45149,7 +61919,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/Status'
+ type: array
+ items:
+ $ref: '#/components/schemas/Status'
description: ''
delete:
operationId: extras_statuses_bulk_destroy
@@ -45163,6 +61935,14 @@ paths:
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
@@ -45206,13 +61986,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Status'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/Status'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/Status'
+ $ref: '#/components/schemas/StatusRequest'
required: true
security:
- cookieAuth: []
@@ -45242,13 +62016,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedStatus'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedStatus'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedStatus'
+ $ref: '#/components/schemas/PatchedStatusRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -45279,11 +62047,78 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -45824,21 +62659,17 @@ paths:
description: ''
post:
operationId: extras_tags_create
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/TagSerializerVersion13'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/TagSerializerVersion13'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/TagSerializerVersion13'
+ $ref: '#/components/schemas/TagSerializerVersion13Request'
required: true
security:
- cookieAuth: []
@@ -45852,21 +62683,19 @@ paths:
description: ''
put:
operationId: extras_tags_bulk_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/TagSerializerVersion13'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/TagSerializerVersion13'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/TagSerializerVersion13'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableTagSerializerVersion13Request'
required: true
security:
- cookieAuth: []
@@ -45876,25 +62705,26 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/TagSerializerVersion13'
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerVersion13'
description: ''
patch:
operationId: extras_tags_bulk_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/PatchedTagSerializerVersion13'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedTagSerializerVersion13'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedTagSerializerVersion13'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableTagSerializerVersion13Request'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -45903,12 +62733,16 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/TagSerializerVersion13'
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerVersion13'
description: ''
delete:
operationId: extras_tags_bulk_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -45917,11 +62751,21 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -45944,8 +62788,10 @@ paths:
description: ''
put:
operationId: extras_tags_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -45960,13 +62806,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/TagSerializerVersion13'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/TagSerializerVersion13'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/TagSerializerVersion13'
+ $ref: '#/components/schemas/TagSerializerVersion13Request'
required: true
security:
- cookieAuth: []
@@ -45980,8 +62820,10 @@ paths:
description: ''
patch:
operationId: extras_tags_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -45996,13 +62838,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedTagSerializerVersion13'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedTagSerializerVersion13'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedTagSerializerVersion13'
+ $ref: '#/components/schemas/PatchedTagSerializerVersion13Request'
security:
- cookieAuth: []
- tokenAuth: []
@@ -46015,8 +62851,10 @@ paths:
description: ''
delete:
operationId: extras_tags_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -46033,6 +62871,71 @@ paths:
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
@@ -46058,6 +62961,132 @@ paths:
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
@@ -46332,13 +63361,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Webhook'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/Webhook'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/Webhook'
+ $ref: '#/components/schemas/WebhookRequest'
required: true
security:
- cookieAuth: []
@@ -46359,13 +63382,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Webhook'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/Webhook'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/Webhook'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableWebhookRequest'
required: true
security:
- cookieAuth: []
@@ -46375,7 +63394,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/Webhook'
+ type: array
+ items:
+ $ref: '#/components/schemas/Webhook'
description: ''
patch:
operationId: extras_webhooks_bulk_partial_update
@@ -46386,13 +63407,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWebhook'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWebhook'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWebhook'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableWebhookRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -46401,7 +63419,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/Webhook'
+ type: array
+ items:
+ $ref: '#/components/schemas/Webhook'
description: ''
delete:
operationId: extras_webhooks_bulk_destroy
@@ -46414,6 +63434,14 @@ paths:
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
@@ -46455,13 +63483,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Webhook'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/Webhook'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/Webhook'
+ $ref: '#/components/schemas/WebhookRequest'
required: true
security:
- cookieAuth: []
@@ -46490,13 +63512,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWebhook'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWebhook'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWebhook'
+ $ref: '#/components/schemas/PatchedWebhookRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -46526,6 +63542,71 @@ paths:
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
@@ -46536,13 +63617,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/GraphQLAPI'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/GraphQLAPI'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/GraphQLAPI'
+ $ref: '#/components/schemas/GraphQLAPIRequest'
required: true
security:
- cookieAuth: []
@@ -46572,8 +63647,10 @@ paths:
/ipam/aggregates/:
get:
operationId: ipam_aggregates_list
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -46872,7 +63949,8 @@ paths:
type: array
items:
type: string
- description: Tenant (slug)
+ format: uuid
+ description: Tenant (slug or ID)
explode: true
style: form
- in: query
@@ -46881,7 +63959,8 @@ paths:
type: array
items:
type: string
- description: Tenant (slug)
+ format: uuid
+ description: Tenant (slug or ID)
explode: true
style: form
- in: query
@@ -46932,7 +64011,7 @@ paths:
type: string
format: uuid
nullable: true
- description: Tenant (ID)
+ description: Tenant (ID) (deprecated, use "tenant" filter instead)
explode: true
style: form
- in: query
@@ -46943,7 +64022,7 @@ paths:
type: string
format: uuid
nullable: true
- description: Tenant (ID)
+ description: Tenant (ID) (deprecated, use "tenant" filter instead)
explode: true
style: form
tags:
@@ -46960,21 +64039,17 @@ paths:
description: ''
post:
operationId: ipam_aggregates_create
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritableAggregate'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableAggregate'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableAggregate'
+ $ref: '#/components/schemas/WritableAggregateRequest'
required: true
security:
- cookieAuth: []
@@ -46988,21 +64063,19 @@ paths:
description: ''
put:
operationId: ipam_aggregates_bulk_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritableAggregate'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableAggregate'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableAggregate'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableAggregateRequest'
required: true
security:
- cookieAuth: []
@@ -47012,25 +64085,26 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/Aggregate'
+ type: array
+ items:
+ $ref: '#/components/schemas/Aggregate'
description: ''
patch:
operationId: ipam_aggregates_bulk_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/PatchedWritableAggregate'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableAggregate'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableAggregate'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableAggregateRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -47039,12 +64113,16 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/Aggregate'
+ type: array
+ items:
+ $ref: '#/components/schemas/Aggregate'
description: ''
delete:
operationId: ipam_aggregates_bulk_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -47053,11 +64131,21 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -47080,8 +64168,10 @@ paths:
description: ''
put:
operationId: ipam_aggregates_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -47096,13 +64186,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableAggregate'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableAggregate'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableAggregate'
+ $ref: '#/components/schemas/WritableAggregateRequest'
required: true
security:
- cookieAuth: []
@@ -47116,8 +64200,10 @@ paths:
description: ''
patch:
operationId: ipam_aggregates_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -47132,13 +64218,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableAggregate'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableAggregate'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableAggregate'
+ $ref: '#/components/schemas/PatchedWritableAggregateRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -47151,8 +64231,10 @@ paths:
description: ''
delete:
operationId: ipam_aggregates_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -47169,6 +64251,71 @@ paths:
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
@@ -47530,6 +64677,132 @@ paths:
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
@@ -47617,7 +64890,8 @@ paths:
type: array
items:
type: string
- description: Tenant (slug)
+ format: uuid
+ description: Tenant (slug or ID)
explode: true
style: form
- in: query
@@ -47626,7 +64900,8 @@ paths:
type: array
items:
type: string
- description: Tenant (slug)
+ format: uuid
+ description: Tenant (slug or ID)
explode: true
style: form
- in: query
@@ -47677,7 +64952,7 @@ paths:
type: string
format: uuid
nullable: true
- description: Tenant (ID)
+ description: Tenant (ID) (deprecated, use "tenant" filter instead)
explode: true
style: form
- in: query
@@ -47688,7 +64963,7 @@ paths:
type: string
format: uuid
nullable: true
- description: Tenant (ID)
+ description: Tenant (ID) (deprecated, use "tenant" filter instead)
explode: true
style: form
- in: query
@@ -47814,13 +65089,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableIPAddress'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableIPAddress'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableIPAddress'
+ $ref: '#/components/schemas/WritableIPAddressRequest'
required: true
security:
- cookieAuth: []
@@ -47842,13 +65111,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableIPAddress'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableIPAddress'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableIPAddress'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableIPAddressRequest'
required: true
security:
- cookieAuth: []
@@ -47858,7 +65123,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/IPAddress'
+ type: array
+ items:
+ $ref: '#/components/schemas/IPAddress'
description: ''
patch:
operationId: ipam_ip_addresses_bulk_partial_update
@@ -47870,13 +65137,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableIPAddress'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableIPAddress'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableIPAddress'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableIPAddressRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -47885,7 +65149,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/IPAddress'
+ type: array
+ items:
+ $ref: '#/components/schemas/IPAddress'
description: ''
delete:
operationId: ipam_ip_addresses_bulk_destroy
@@ -47899,6 +65165,14 @@ paths:
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
@@ -47942,13 +65216,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableIPAddress'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableIPAddress'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableIPAddress'
+ $ref: '#/components/schemas/WritableIPAddressRequest'
required: true
security:
- cookieAuth: []
@@ -47978,13 +65246,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableIPAddress'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableIPAddress'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableIPAddress'
+ $ref: '#/components/schemas/PatchedWritableIPAddressRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -48015,6 +65277,71 @@ paths:
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
@@ -48197,6 +65524,26 @@ paths:
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:
@@ -48248,7 +65595,7 @@ paths:
items:
type: string
format: uuid
- description: Region (slug)
+ description: Region (slug or ID)
explode: true
style: form
- in: query
@@ -48258,7 +65605,7 @@ paths:
items:
type: string
format: uuid
- description: Region (slug)
+ description: Region (slug or ID)
explode: true
style: form
- in: query
@@ -48268,7 +65615,7 @@ paths:
items:
type: string
format: uuid
- description: Region (ID)
+ description: Region (ID) (deprecated, use "region" filter instead)
explode: true
style: form
- in: query
@@ -48278,7 +65625,7 @@ paths:
items:
type: string
format: uuid
- description: Region (ID)
+ description: Region (ID) (deprecated, use "region" filter instead)
explode: true
style: form
- in: query
@@ -48327,7 +65674,8 @@ paths:
type: array
items:
type: string
- description: Site (slug)
+ format: uuid
+ description: Site (slug or ID)
explode: true
style: form
- in: query
@@ -48336,7 +65684,8 @@ paths:
type: array
items:
type: string
- description: Site (slug)
+ format: uuid
+ description: Site (slug or ID)
explode: true
style: form
- in: query
@@ -48347,7 +65696,7 @@ paths:
type: string
format: uuid
nullable: true
- description: Site (ID)
+ description: Site (ID) (deprecated, use "site" filter instead)
explode: true
style: form
- in: query
@@ -48358,7 +65707,7 @@ paths:
type: string
format: uuid
nullable: true
- description: Site (ID)
+ description: Site (ID) (deprecated, use "site" filter instead)
explode: true
style: form
- in: query
@@ -48401,7 +65750,8 @@ paths:
type: array
items:
type: string
- description: Tenant (slug)
+ format: uuid
+ description: Tenant (slug or ID)
explode: true
style: form
- in: query
@@ -48410,7 +65760,8 @@ paths:
type: array
items:
type: string
- description: Tenant (slug)
+ format: uuid
+ description: Tenant (slug or ID)
explode: true
style: form
- in: query
@@ -48461,7 +65812,7 @@ paths:
type: string
format: uuid
nullable: true
- description: Tenant (ID)
+ description: Tenant (ID) (deprecated, use "tenant" filter instead)
explode: true
style: form
- in: query
@@ -48472,7 +65823,7 @@ paths:
type: string
format: uuid
nullable: true
- description: Tenant (ID)
+ description: Tenant (ID) (deprecated, use "tenant" filter instead)
explode: true
style: form
- in: query
@@ -48578,13 +65929,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritablePrefix'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritablePrefix'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritablePrefix'
+ $ref: '#/components/schemas/WritablePrefixRequest'
required: true
security:
- cookieAuth: []
@@ -48606,13 +65951,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritablePrefix'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritablePrefix'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritablePrefix'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritablePrefixRequest'
required: true
security:
- cookieAuth: []
@@ -48622,7 +65963,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/Prefix'
+ type: array
+ items:
+ $ref: '#/components/schemas/Prefix'
description: ''
patch:
operationId: ipam_prefixes_bulk_partial_update
@@ -48634,13 +65977,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritablePrefix'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritablePrefix'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritablePrefix'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritablePrefixRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -48649,7 +65989,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/Prefix'
+ type: array
+ items:
+ $ref: '#/components/schemas/Prefix'
description: ''
delete:
operationId: ipam_prefixes_bulk_destroy
@@ -48663,6 +66005,14 @@ paths:
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
@@ -48706,13 +66056,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritablePrefix'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritablePrefix'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritablePrefix'
+ $ref: '#/components/schemas/WritablePrefixRequest'
required: true
security:
- cookieAuth: []
@@ -48742,13 +66086,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritablePrefix'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritablePrefix'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritablePrefix'
+ $ref: '#/components/schemas/PatchedWritablePrefixRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -48852,24 +66190,6 @@ paths:
type: integer
tags:
- ipam
- requestBody:
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/AvailableIP'
- application/x-www-form-urlencoded:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/AvailableIP'
- multipart/form-data:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/AvailableIP'
- required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -48941,13 +66261,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PrefixLength'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PrefixLength'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PrefixLength'
+ $ref: '#/components/schemas/PrefixLengthRequest'
required: true
security:
- cookieAuth: []
@@ -48959,11 +66273,78 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -49492,21 +66873,17 @@ paths:
description: ''
post:
operationId: ipam_rirs_create
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/RIR'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/RIR'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/RIR'
+ $ref: '#/components/schemas/RIRRequest'
required: true
security:
- cookieAuth: []
@@ -49520,21 +66897,19 @@ paths:
description: ''
put:
operationId: ipam_rirs_bulk_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/RIR'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/RIR'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/RIR'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableRIRRequest'
required: true
security:
- cookieAuth: []
@@ -49544,25 +66919,26 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/RIR'
+ type: array
+ items:
+ $ref: '#/components/schemas/RIR'
description: ''
patch:
operationId: ipam_rirs_bulk_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/PatchedRIR'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedRIR'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedRIR'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableRIRRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -49571,12 +66947,16 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/RIR'
+ type: array
+ items:
+ $ref: '#/components/schemas/RIR'
description: ''
delete:
operationId: ipam_rirs_bulk_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -49585,11 +66965,21 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -49612,8 +67002,10 @@ paths:
description: ''
put:
operationId: ipam_rirs_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -49628,13 +67020,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/RIR'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/RIR'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/RIR'
+ $ref: '#/components/schemas/RIRRequest'
required: true
security:
- cookieAuth: []
@@ -49648,8 +67034,10 @@ paths:
description: ''
patch:
operationId: ipam_rirs_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -49664,13 +67052,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedRIR'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedRIR'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedRIR'
+ $ref: '#/components/schemas/PatchedRIRRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -49683,8 +67065,10 @@ paths:
description: ''
delete:
operationId: ipam_rirs_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -49701,11 +67085,78 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -50118,21 +67569,17 @@ paths:
description: ''
post:
operationId: ipam_roles_create
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/Role'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/Role'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/Role'
+ $ref: '#/components/schemas/RoleRequest'
required: true
security:
- cookieAuth: []
@@ -50146,21 +67593,19 @@ paths:
description: ''
put:
operationId: ipam_roles_bulk_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/Role'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/Role'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/Role'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableRoleRequest'
required: true
security:
- cookieAuth: []
@@ -50170,25 +67615,26 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/Role'
+ type: array
+ items:
+ $ref: '#/components/schemas/Role'
description: ''
patch:
operationId: ipam_roles_bulk_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/PatchedRole'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedRole'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedRole'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableRoleRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -50197,12 +67643,16 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/Role'
+ type: array
+ items:
+ $ref: '#/components/schemas/Role'
description: ''
delete:
operationId: ipam_roles_bulk_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -50211,11 +67661,21 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -50238,8 +67698,10 @@ paths:
description: ''
put:
operationId: ipam_roles_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -50254,13 +67716,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Role'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/Role'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/Role'
+ $ref: '#/components/schemas/RoleRequest'
required: true
security:
- cookieAuth: []
@@ -50274,8 +67730,10 @@ paths:
description: ''
patch:
operationId: ipam_roles_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -50290,13 +67748,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedRole'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedRole'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedRole'
+ $ref: '#/components/schemas/PatchedRoleRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -50309,8 +67761,10 @@ paths:
description: ''
delete:
operationId: ipam_roles_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -50327,11 +67781,78 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -50724,7 +68245,8 @@ paths:
type: array
items:
type: string
- description: Tenant (slug)
+ format: uuid
+ description: Tenant (slug or ID)
explode: true
style: form
- in: query
@@ -50733,7 +68255,8 @@ paths:
type: array
items:
type: string
- description: Tenant (slug)
+ format: uuid
+ description: Tenant (slug or ID)
explode: true
style: form
- in: query
@@ -50784,7 +68307,7 @@ paths:
type: string
format: uuid
nullable: true
- description: Tenant (ID)
+ description: Tenant (ID) (deprecated, use "tenant" filter instead)
explode: true
style: form
- in: query
@@ -50795,7 +68318,7 @@ paths:
type: string
format: uuid
nullable: true
- description: Tenant (ID)
+ description: Tenant (ID) (deprecated, use "tenant" filter instead)
explode: true
style: form
tags:
@@ -50812,21 +68335,17 @@ paths:
description: ''
post:
operationId: ipam_route_targets_create
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritableRouteTarget'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableRouteTarget'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableRouteTarget'
+ $ref: '#/components/schemas/WritableRouteTargetRequest'
required: true
security:
- cookieAuth: []
@@ -50840,21 +68359,19 @@ paths:
description: ''
put:
operationId: ipam_route_targets_bulk_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritableRouteTarget'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableRouteTarget'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableRouteTarget'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableRouteTargetRequest'
required: true
security:
- cookieAuth: []
@@ -50864,25 +68381,26 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/RouteTarget'
+ type: array
+ items:
+ $ref: '#/components/schemas/RouteTarget'
description: ''
patch:
operationId: ipam_route_targets_bulk_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/PatchedWritableRouteTarget'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableRouteTarget'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableRouteTarget'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableRouteTargetRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -50891,12 +68409,16 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/RouteTarget'
+ type: array
+ items:
+ $ref: '#/components/schemas/RouteTarget'
description: ''
delete:
operationId: ipam_route_targets_bulk_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -50905,11 +68427,21 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -50932,8 +68464,10 @@ paths:
description: ''
put:
operationId: ipam_route_targets_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -50948,13 +68482,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableRouteTarget'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableRouteTarget'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableRouteTarget'
+ $ref: '#/components/schemas/WritableRouteTargetRequest'
required: true
security:
- cookieAuth: []
@@ -50968,8 +68496,10 @@ paths:
description: ''
patch:
operationId: ipam_route_targets_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -50984,13 +68514,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableRouteTarget'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableRouteTarget'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableRouteTarget'
+ $ref: '#/components/schemas/PatchedWritableRouteTargetRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -51003,8 +68527,10 @@ paths:
description: ''
delete:
operationId: ipam_route_targets_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -51021,11 +68547,78 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -51436,21 +69029,17 @@ paths:
description: ''
post:
operationId: ipam_services_create
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritableService'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableService'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableService'
+ $ref: '#/components/schemas/WritableServiceRequest'
required: true
security:
- cookieAuth: []
@@ -51464,21 +69053,19 @@ paths:
description: ''
put:
operationId: ipam_services_bulk_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritableService'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableService'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableService'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableServiceRequest'
required: true
security:
- cookieAuth: []
@@ -51488,25 +69075,26 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/Service'
+ type: array
+ items:
+ $ref: '#/components/schemas/Service'
description: ''
patch:
operationId: ipam_services_bulk_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/PatchedWritableService'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableService'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableService'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableServiceRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -51515,12 +69103,16 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/Service'
+ type: array
+ items:
+ $ref: '#/components/schemas/Service'
description: ''
delete:
operationId: ipam_services_bulk_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -51529,11 +69121,21 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -51556,8 +69158,10 @@ paths:
description: ''
put:
operationId: ipam_services_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -51572,13 +69176,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableService'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableService'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableService'
+ $ref: '#/components/schemas/WritableServiceRequest'
required: true
security:
- cookieAuth: []
@@ -51592,8 +69190,10 @@ paths:
description: ''
patch:
operationId: ipam_services_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -51608,13 +69208,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableService'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableService'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableService'
+ $ref: '#/components/schemas/PatchedWritableServiceRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -51627,8 +69221,10 @@ paths:
description: ''
delete:
operationId: ipam_services_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -51645,11 +69241,78 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -51925,6 +69588,26 @@ paths:
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:
@@ -52055,7 +69738,7 @@ paths:
items:
type: string
format: uuid
- description: Region (slug)
+ description: Region (slug or ID)
explode: true
style: form
- in: query
@@ -52065,7 +69748,7 @@ paths:
items:
type: string
format: uuid
- description: Region (slug)
+ description: Region (slug or ID)
explode: true
style: form
- in: query
@@ -52075,7 +69758,7 @@ paths:
items:
type: string
format: uuid
- description: Region (ID)
+ description: Region (ID) (deprecated, use "region" filter instead)
explode: true
style: form
- in: query
@@ -52085,7 +69768,7 @@ paths:
items:
type: string
format: uuid
- description: Region (ID)
+ description: Region (ID) (deprecated, use "region" filter instead)
explode: true
style: form
- in: query
@@ -52094,7 +69777,8 @@ paths:
type: array
items:
type: string
- description: Site (slug)
+ format: uuid
+ description: Site (slug or ID)
explode: true
style: form
- in: query
@@ -52103,7 +69787,8 @@ paths:
type: array
items:
type: string
- description: Site (slug)
+ format: uuid
+ description: Site (slug or ID)
explode: true
style: form
- in: query
@@ -52114,7 +69799,7 @@ paths:
type: string
format: uuid
nullable: true
- description: Site (ID)
+ description: Site (ID) (deprecated, use "site" filter instead)
explode: true
style: form
- in: query
@@ -52125,7 +69810,7 @@ paths:
type: string
format: uuid
nullable: true
- description: Site (ID)
+ description: Site (ID) (deprecated, use "site" filter instead)
explode: true
style: form
- in: query
@@ -52254,21 +69939,17 @@ paths:
description: ''
post:
operationId: ipam_vlan_groups_create
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritableVLANGroup'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableVLANGroup'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableVLANGroup'
+ $ref: '#/components/schemas/WritableVLANGroupRequest'
required: true
security:
- cookieAuth: []
@@ -52282,21 +69963,19 @@ paths:
description: ''
put:
operationId: ipam_vlan_groups_bulk_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritableVLANGroup'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableVLANGroup'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableVLANGroup'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableVLANGroupRequest'
required: true
security:
- cookieAuth: []
@@ -52306,25 +69985,26 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/VLANGroup'
+ type: array
+ items:
+ $ref: '#/components/schemas/VLANGroup'
description: ''
patch:
operationId: ipam_vlan_groups_bulk_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/PatchedWritableVLANGroup'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableVLANGroup'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableVLANGroup'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableVLANGroupRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -52333,12 +70013,16 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/VLANGroup'
+ type: array
+ items:
+ $ref: '#/components/schemas/VLANGroup'
description: ''
delete:
operationId: ipam_vlan_groups_bulk_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -52347,11 +70031,21 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -52374,8 +70068,10 @@ paths:
description: ''
put:
operationId: ipam_vlan_groups_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -52390,13 +70086,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableVLANGroup'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableVLANGroup'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableVLANGroup'
+ $ref: '#/components/schemas/WritableVLANGroupRequest'
required: true
security:
- cookieAuth: []
@@ -52410,8 +70100,10 @@ paths:
description: ''
patch:
operationId: ipam_vlan_groups_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -52426,13 +70118,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableVLANGroup'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableVLANGroup'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableVLANGroup'
+ $ref: '#/components/schemas/PatchedWritableVLANGroupRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -52445,8 +70131,10 @@ paths:
description: ''
delete:
operationId: ipam_vlan_groups_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -52463,12 +70151,83 @@ paths:
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:
@@ -52671,6 +70430,26 @@ paths:
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:
@@ -52801,7 +70580,7 @@ paths:
items:
type: string
format: uuid
- description: Region (slug)
+ description: Region (slug or ID)
explode: true
style: form
- in: query
@@ -52811,7 +70590,7 @@ paths:
items:
type: string
format: uuid
- description: Region (slug)
+ description: Region (slug or ID)
explode: true
style: form
- in: query
@@ -52821,7 +70600,7 @@ paths:
items:
type: string
format: uuid
- description: Region (ID)
+ description: Region (ID) (deprecated, use "region" filter instead)
explode: true
style: form
- in: query
@@ -52831,7 +70610,7 @@ paths:
items:
type: string
format: uuid
- description: Region (ID)
+ description: Region (ID) (deprecated, use "region" filter instead)
explode: true
style: form
- in: query
@@ -52880,7 +70659,8 @@ paths:
type: array
items:
type: string
- description: Site (slug)
+ format: uuid
+ description: Site (slug or ID)
explode: true
style: form
- in: query
@@ -52889,7 +70669,8 @@ paths:
type: array
items:
type: string
- description: Site (slug)
+ format: uuid
+ description: Site (slug or ID)
explode: true
style: form
- in: query
@@ -52900,7 +70681,7 @@ paths:
type: string
format: uuid
nullable: true
- description: Site (ID)
+ description: Site (ID) (deprecated, use "site" filter instead)
explode: true
style: form
- in: query
@@ -52911,7 +70692,7 @@ paths:
type: string
format: uuid
nullable: true
- description: Site (ID)
+ description: Site (ID) (deprecated, use "site" filter instead)
explode: true
style: form
- in: query
@@ -52954,7 +70735,8 @@ paths:
type: array
items:
type: string
- description: Tenant (slug)
+ format: uuid
+ description: Tenant (slug or ID)
explode: true
style: form
- in: query
@@ -52963,7 +70745,8 @@ paths:
type: array
items:
type: string
- description: Tenant (slug)
+ format: uuid
+ description: Tenant (slug or ID)
explode: true
style: form
- in: query
@@ -53014,7 +70797,7 @@ paths:
type: string
format: uuid
nullable: true
- description: Tenant (ID)
+ description: Tenant (ID) (deprecated, use "tenant" filter instead)
explode: true
style: form
- in: query
@@ -53025,7 +70808,7 @@ paths:
type: string
format: uuid
nullable: true
- description: Tenant (ID)
+ description: Tenant (ID) (deprecated, use "tenant" filter instead)
explode: true
style: form
- in: query
@@ -53098,13 +70881,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableVLAN'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableVLAN'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableVLAN'
+ $ref: '#/components/schemas/WritableVLANRequest'
required: true
security:
- cookieAuth: []
@@ -53126,13 +70903,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableVLAN'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableVLAN'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableVLAN'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableVLANRequest'
required: true
security:
- cookieAuth: []
@@ -53142,7 +70915,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/VLAN'
+ type: array
+ items:
+ $ref: '#/components/schemas/VLAN'
description: ''
patch:
operationId: ipam_vlans_bulk_partial_update
@@ -53154,13 +70929,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableVLAN'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableVLAN'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableVLAN'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableVLANRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -53169,7 +70941,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/VLAN'
+ type: array
+ items:
+ $ref: '#/components/schemas/VLAN'
description: ''
delete:
operationId: ipam_vlans_bulk_destroy
@@ -53183,6 +70957,14 @@ paths:
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
@@ -53226,13 +71008,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableVLAN'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableVLAN'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableVLAN'
+ $ref: '#/components/schemas/WritableVLANRequest'
required: true
security:
- cookieAuth: []
@@ -53262,13 +71038,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableVLAN'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableVLAN'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableVLAN'
+ $ref: '#/components/schemas/PatchedWritableVLANRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -53299,11 +71069,78 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -53804,7 +71641,8 @@ paths:
type: array
items:
type: string
- description: Tenant (slug)
+ format: uuid
+ description: Tenant (slug or ID)
explode: true
style: form
- in: query
@@ -53813,7 +71651,8 @@ paths:
type: array
items:
type: string
- description: Tenant (slug)
+ format: uuid
+ description: Tenant (slug or ID)
explode: true
style: form
- in: query
@@ -53864,7 +71703,7 @@ paths:
type: string
format: uuid
nullable: true
- description: Tenant (ID)
+ description: Tenant (ID) (deprecated, use "tenant" filter instead)
explode: true
style: form
- in: query
@@ -53875,7 +71714,7 @@ paths:
type: string
format: uuid
nullable: true
- description: Tenant (ID)
+ description: Tenant (ID) (deprecated, use "tenant" filter instead)
explode: true
style: form
tags:
@@ -53892,21 +71731,17 @@ paths:
description: ''
post:
operationId: ipam_vrfs_create
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritableVRF'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableVRF'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableVRF'
+ $ref: '#/components/schemas/WritableVRFRequest'
required: true
security:
- cookieAuth: []
@@ -53920,21 +71755,19 @@ paths:
description: ''
put:
operationId: ipam_vrfs_bulk_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritableVRF'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableVRF'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableVRF'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableVRFRequest'
required: true
security:
- cookieAuth: []
@@ -53944,25 +71777,26 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/VRF'
+ type: array
+ items:
+ $ref: '#/components/schemas/VRF'
description: ''
patch:
operationId: ipam_vrfs_bulk_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/PatchedWritableVRF'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableVRF'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableVRF'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableVRFRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -53971,12 +71805,16 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/VRF'
+ type: array
+ items:
+ $ref: '#/components/schemas/VRF'
description: ''
delete:
operationId: ipam_vrfs_bulk_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -53985,11 +71823,21 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -54012,8 +71860,10 @@ paths:
description: ''
put:
operationId: ipam_vrfs_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -54028,13 +71878,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableVRF'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableVRF'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableVRF'
+ $ref: '#/components/schemas/WritableVRFRequest'
required: true
security:
- cookieAuth: []
@@ -54048,8 +71892,10 @@ paths:
description: ''
patch:
operationId: ipam_vrfs_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -54064,13 +71910,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableVRF'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableVRF'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableVRF'
+ $ref: '#/components/schemas/PatchedWritableVRFRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -54083,8 +71923,10 @@ paths:
description: ''
delete:
operationId: ipam_vrfs_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -54101,29 +71943,253 @@ paths:
responses:
'204':
description: No response body
- /plugins/chatops/accessgrant/:
+ /ipam/vrfs/{id}/notes/:
get:
- operationId: plugins_chatops_accessgrant_list
- description: API viewset for interacting with AccessGrant objects.
+ operationId: ipam_vrfs_notes_list
+ description: API methods for returning or creating notes on an object.
parameters:
- - in: query
- name: command
+ - 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: grant_type
+ 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
@@ -54137,13 +72203,4232 @@ paths:
schema:
type: integer
- in: query
- name: subcommand
+ 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: value
+ 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:
@@ -54165,13 +76450,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/AccessGrant'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/AccessGrant'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/AccessGrant'
+ $ref: '#/components/schemas/AccessGrantRequest'
required: true
security:
- cookieAuth: []
@@ -54192,13 +76471,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/AccessGrant'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/AccessGrant'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/AccessGrant'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableAccessGrantRequest'
required: true
security:
- cookieAuth: []
@@ -54208,7 +76483,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/AccessGrant'
+ type: array
+ items:
+ $ref: '#/components/schemas/AccessGrant'
description: ''
patch:
operationId: plugins_chatops_accessgrant_bulk_partial_update
@@ -54219,13 +76496,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedAccessGrant'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedAccessGrant'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedAccessGrant'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableAccessGrantRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -54234,7 +76508,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/AccessGrant'
+ type: array
+ items:
+ $ref: '#/components/schemas/AccessGrant'
description: ''
delete:
operationId: plugins_chatops_accessgrant_bulk_destroy
@@ -54247,6 +76523,14 @@ paths:
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
@@ -54288,13 +76572,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/AccessGrant'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/AccessGrant'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/AccessGrant'
+ $ref: '#/components/schemas/AccessGrantRequest'
required: true
security:
- cookieAuth: []
@@ -54323,13 +76601,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedAccessGrant'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedAccessGrant'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedAccessGrant'
+ $ref: '#/components/schemas/PatchedAccessGrantRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -54367,17 +76639,241 @@ paths:
- in: query
name: comment
schema:
- type: string
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
- in: query
- name: created
+ name: comment__ic
schema:
- type: string
- format: date
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
- in: query
- name: last_updated
+ name: comment__ie
schema:
- type: string
- format: date-time
+ 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
@@ -54394,6 +76890,10 @@ paths:
name: platform
schema:
type: string
+ - in: query
+ name: platform__n
+ schema:
+ type: string
tags:
- plugins
security:
@@ -54415,13 +76915,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/CommandToken'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/CommandToken'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/CommandToken'
+ $ref: '#/components/schemas/CommandTokenRequest'
required: true
security:
- cookieAuth: []
@@ -54442,13 +76936,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/CommandToken'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/CommandToken'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/CommandToken'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableCommandTokenRequest'
required: true
security:
- cookieAuth: []
@@ -54458,7 +76948,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/CommandToken'
+ type: array
+ items:
+ $ref: '#/components/schemas/CommandToken'
description: ''
patch:
operationId: plugins_chatops_commandtoken_bulk_partial_update
@@ -54469,13 +76961,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedCommandToken'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedCommandToken'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedCommandToken'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableCommandTokenRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -54484,7 +76973,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/CommandToken'
+ type: array
+ items:
+ $ref: '#/components/schemas/CommandToken'
description: ''
delete:
operationId: plugins_chatops_commandtoken_bulk_destroy
@@ -54497,6 +76988,14 @@ paths:
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
@@ -54538,13 +77037,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/CommandToken'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/CommandToken'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/CommandToken'
+ $ref: '#/components/schemas/CommandTokenRequest'
required: true
security:
- cookieAuth: []
@@ -54573,13 +77066,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedCommandToken'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedCommandToken'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedCommandToken'
+ $ref: '#/components/schemas/PatchedCommandTokenRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -54803,13 +77290,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/CircuitMaintenanceCircuitImpact'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/CircuitMaintenanceCircuitImpact'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/CircuitMaintenanceCircuitImpact'
+ $ref: '#/components/schemas/CircuitMaintenanceCircuitImpactRequest'
required: true
security:
- cookieAuth: []
@@ -54830,13 +77311,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/CircuitMaintenanceCircuitImpact'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/CircuitMaintenanceCircuitImpact'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/CircuitMaintenanceCircuitImpact'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableCircuitMaintenanceCircuitImpactRequest'
required: true
security:
- cookieAuth: []
@@ -54846,7 +77323,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/CircuitMaintenanceCircuitImpact'
+ type: array
+ items:
+ $ref: '#/components/schemas/CircuitMaintenanceCircuitImpact'
description: ''
patch:
operationId: plugins_circuit_maintenance_circuitimpact_bulk_partial_update
@@ -54857,13 +77336,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedCircuitMaintenanceCircuitImpact'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedCircuitMaintenanceCircuitImpact'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedCircuitMaintenanceCircuitImpact'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableCircuitMaintenanceCircuitImpactRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -54872,7 +77348,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/CircuitMaintenanceCircuitImpact'
+ type: array
+ items:
+ $ref: '#/components/schemas/CircuitMaintenanceCircuitImpact'
description: ''
delete:
operationId: plugins_circuit_maintenance_circuitimpact_bulk_destroy
@@ -54885,6 +77363,14 @@ paths:
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
@@ -54926,13 +77412,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/CircuitMaintenanceCircuitImpact'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/CircuitMaintenanceCircuitImpact'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/CircuitMaintenanceCircuitImpact'
+ $ref: '#/components/schemas/CircuitMaintenanceCircuitImpactRequest'
required: true
security:
- cookieAuth: []
@@ -54961,13 +77441,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedCircuitMaintenanceCircuitImpact'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedCircuitMaintenanceCircuitImpact'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedCircuitMaintenanceCircuitImpact'
+ $ref: '#/components/schemas/PatchedCircuitMaintenanceCircuitImpactRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -55020,6 +77494,132 @@ paths:
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
@@ -55194,13 +77794,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/CircuitMaintenance'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/CircuitMaintenance'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/CircuitMaintenance'
+ $ref: '#/components/schemas/CircuitMaintenanceRequest'
required: true
security:
- cookieAuth: []
@@ -55221,13 +77815,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/CircuitMaintenance'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/CircuitMaintenance'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/CircuitMaintenance'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableCircuitMaintenanceRequest'
required: true
security:
- cookieAuth: []
@@ -55237,7 +77827,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/CircuitMaintenance'
+ type: array
+ items:
+ $ref: '#/components/schemas/CircuitMaintenance'
description: ''
patch:
operationId: plugins_circuit_maintenance_maintenance_bulk_partial_update
@@ -55248,13 +77840,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedCircuitMaintenance'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedCircuitMaintenance'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedCircuitMaintenance'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableCircuitMaintenanceRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -55263,7 +77852,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/CircuitMaintenance'
+ type: array
+ items:
+ $ref: '#/components/schemas/CircuitMaintenance'
description: ''
delete:
operationId: plugins_circuit_maintenance_maintenance_bulk_destroy
@@ -55276,6 +77867,14 @@ paths:
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
@@ -55317,13 +77916,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/CircuitMaintenance'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/CircuitMaintenance'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/CircuitMaintenance'
+ $ref: '#/components/schemas/CircuitMaintenanceRequest'
required: true
security:
- cookieAuth: []
@@ -55352,13 +77945,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedCircuitMaintenance'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedCircuitMaintenance'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedCircuitMaintenance'
+ $ref: '#/components/schemas/PatchedCircuitMaintenanceRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -55426,13 +78013,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Note'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/Note'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/Note'
+ $ref: '#/components/schemas/NoteRequest'
required: true
security:
- cookieAuth: []
@@ -55453,13 +78034,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Note'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/Note'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/Note'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableNoteRequest'
required: true
security:
- cookieAuth: []
@@ -55469,7 +78046,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/Note'
+ type: array
+ items:
+ $ref: '#/components/schemas/Note'
description: ''
patch:
operationId: plugins_circuit_maintenance_note_bulk_partial_update
@@ -55480,13 +78059,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedNote'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedNote'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedNote'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableNoteRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -55495,7 +78071,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/Note'
+ type: array
+ items:
+ $ref: '#/components/schemas/Note'
description: ''
delete:
operationId: plugins_circuit_maintenance_note_bulk_destroy
@@ -55508,6 +78086,14 @@ paths:
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
@@ -55549,13 +78135,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Note'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/Note'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/Note'
+ $ref: '#/components/schemas/NoteRequest'
required: true
security:
- cookieAuth: []
@@ -55584,13 +78164,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedNote'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedNote'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedNote'
+ $ref: '#/components/schemas/PatchedNoteRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -55629,6 +78203,132 @@ paths:
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
@@ -56681,13 +79381,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/MinMaxValidationRule'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/MinMaxValidationRule'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/MinMaxValidationRule'
+ $ref: '#/components/schemas/MinMaxValidationRuleRequest'
required: true
security:
- cookieAuth: []
@@ -56708,13 +79402,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/MinMaxValidationRule'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/MinMaxValidationRule'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/MinMaxValidationRule'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableMinMaxValidationRuleRequest'
required: true
security:
- cookieAuth: []
@@ -56724,7 +79414,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/MinMaxValidationRule'
+ type: array
+ items:
+ $ref: '#/components/schemas/MinMaxValidationRule'
description: ''
patch:
operationId: plugins_data_validation_engine_rules_min_max_bulk_partial_update
@@ -56735,13 +79427,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedMinMaxValidationRule'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedMinMaxValidationRule'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedMinMaxValidationRule'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableMinMaxValidationRuleRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -56750,7 +79439,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/MinMaxValidationRule'
+ type: array
+ items:
+ $ref: '#/components/schemas/MinMaxValidationRule'
description: ''
delete:
operationId: plugins_data_validation_engine_rules_min_max_bulk_destroy
@@ -56763,6 +79454,14 @@ paths:
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
@@ -56804,13 +79503,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/MinMaxValidationRule'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/MinMaxValidationRule'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/MinMaxValidationRule'
+ $ref: '#/components/schemas/MinMaxValidationRuleRequest'
required: true
security:
- cookieAuth: []
@@ -56839,13 +79532,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedMinMaxValidationRule'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedMinMaxValidationRule'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedMinMaxValidationRule'
+ $ref: '#/components/schemas/PatchedMinMaxValidationRuleRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -57654,13 +80341,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/RegularExpressionValidationRule'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/RegularExpressionValidationRule'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/RegularExpressionValidationRule'
+ $ref: '#/components/schemas/RegularExpressionValidationRuleRequest'
required: true
security:
- cookieAuth: []
@@ -57681,13 +80362,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/RegularExpressionValidationRule'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/RegularExpressionValidationRule'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/RegularExpressionValidationRule'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableRegularExpressionValidationRuleRequest'
required: true
security:
- cookieAuth: []
@@ -57697,7 +80374,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/RegularExpressionValidationRule'
+ type: array
+ items:
+ $ref: '#/components/schemas/RegularExpressionValidationRule'
description: ''
patch:
operationId: plugins_data_validation_engine_rules_regex_bulk_partial_update
@@ -57708,13 +80387,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedRegularExpressionValidationRule'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedRegularExpressionValidationRule'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedRegularExpressionValidationRule'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableRegularExpressionValidationRuleRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -57723,7 +80399,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/RegularExpressionValidationRule'
+ type: array
+ items:
+ $ref: '#/components/schemas/RegularExpressionValidationRule'
description: ''
delete:
operationId: plugins_data_validation_engine_rules_regex_bulk_destroy
@@ -57736,6 +80414,14 @@ paths:
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
@@ -57779,13 +80465,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/RegularExpressionValidationRule'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/RegularExpressionValidationRule'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/RegularExpressionValidationRule'
+ $ref: '#/components/schemas/RegularExpressionValidationRuleRequest'
required: true
security:
- cookieAuth: []
@@ -57815,13 +80495,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedRegularExpressionValidationRule'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedRegularExpressionValidationRule'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedRegularExpressionValidationRule'
+ $ref: '#/components/schemas/PatchedRegularExpressionValidationRuleRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -57955,13 +80629,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/OnboardingTask'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/OnboardingTask'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/OnboardingTask'
+ $ref: '#/components/schemas/OnboardingTaskRequest'
required: true
security:
- cookieAuth: []
@@ -58022,6 +80690,9716 @@ paths:
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
@@ -58053,6 +90431,10 @@ paths:
schema:
type: string
description: Search
+ - in: query
+ name: slug
+ schema:
+ type: string
tags:
- plugins
security:
@@ -58074,13 +90456,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/ComplianceFeature'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/ComplianceFeature'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/ComplianceFeature'
+ $ref: '#/components/schemas/ComplianceFeatureRequest'
required: true
security:
- cookieAuth: []
@@ -58101,13 +90477,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/ComplianceFeature'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/ComplianceFeature'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/ComplianceFeature'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableComplianceFeatureRequest'
required: true
security:
- cookieAuth: []
@@ -58117,7 +90489,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/ComplianceFeature'
+ type: array
+ items:
+ $ref: '#/components/schemas/ComplianceFeature'
description: ''
patch:
operationId: plugins_golden_config_compliance_feature_bulk_partial_update
@@ -58128,13 +90502,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedComplianceFeature'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedComplianceFeature'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedComplianceFeature'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableComplianceFeatureRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -58143,7 +90514,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/ComplianceFeature'
+ type: array
+ items:
+ $ref: '#/components/schemas/ComplianceFeature'
description: ''
delete:
operationId: plugins_golden_config_compliance_feature_bulk_destroy
@@ -58156,6 +90529,14 @@ paths:
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
@@ -58197,13 +90578,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/ComplianceFeature'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/ComplianceFeature'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/ComplianceFeature'
+ $ref: '#/components/schemas/ComplianceFeatureRequest'
required: true
security:
- cookieAuth: []
@@ -58232,13 +90607,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedComplianceFeature'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedComplianceFeature'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedComplianceFeature'
+ $ref: '#/components/schemas/PatchedComplianceFeatureRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -58340,13 +90709,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/ComplianceRule'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/ComplianceRule'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/ComplianceRule'
+ $ref: '#/components/schemas/ComplianceRuleRequest'
required: true
security:
- cookieAuth: []
@@ -58367,13 +90730,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/ComplianceRule'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/ComplianceRule'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/ComplianceRule'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableComplianceRuleRequest'
required: true
security:
- cookieAuth: []
@@ -58383,7 +90742,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/ComplianceRule'
+ type: array
+ items:
+ $ref: '#/components/schemas/ComplianceRule'
description: ''
patch:
operationId: plugins_golden_config_compliance_rule_bulk_partial_update
@@ -58394,13 +90755,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedComplianceRule'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedComplianceRule'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedComplianceRule'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableComplianceRuleRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -58409,7 +90767,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/ComplianceRule'
+ type: array
+ items:
+ $ref: '#/components/schemas/ComplianceRule'
description: ''
delete:
operationId: plugins_golden_config_compliance_rule_bulk_destroy
@@ -58422,6 +90782,14 @@ paths:
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
@@ -58463,13 +90831,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/ComplianceRule'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/ComplianceRule'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/ComplianceRule'
+ $ref: '#/components/schemas/ComplianceRuleRequest'
required: true
security:
- cookieAuth: []
@@ -58498,13 +90860,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedComplianceRule'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedComplianceRule'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedComplianceRule'
+ $ref: '#/components/schemas/PatchedComplianceRuleRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -58816,13 +91172,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/ConfigCompliance'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/ConfigCompliance'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/ConfigCompliance'
+ $ref: '#/components/schemas/ConfigComplianceRequest'
required: true
security:
- cookieAuth: []
@@ -58843,13 +91193,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/ConfigCompliance'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/ConfigCompliance'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/ConfigCompliance'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableConfigComplianceRequest'
required: true
security:
- cookieAuth: []
@@ -58859,7 +91205,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/ConfigCompliance'
+ type: array
+ items:
+ $ref: '#/components/schemas/ConfigCompliance'
description: ''
patch:
operationId: plugins_golden_config_config_compliance_bulk_partial_update
@@ -58870,13 +91218,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedConfigCompliance'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedConfigCompliance'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedConfigCompliance'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableConfigComplianceRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -58885,7 +91230,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/ConfigCompliance'
+ type: array
+ items:
+ $ref: '#/components/schemas/ConfigCompliance'
description: ''
delete:
operationId: plugins_golden_config_config_compliance_bulk_destroy
@@ -58898,6 +91245,14 @@ paths:
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
@@ -58939,13 +91294,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/ConfigCompliance'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/ConfigCompliance'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/ConfigCompliance'
+ $ref: '#/components/schemas/ConfigComplianceRequest'
required: true
security:
- cookieAuth: []
@@ -58974,13 +91323,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedConfigCompliance'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedConfigCompliance'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedConfigCompliance'
+ $ref: '#/components/schemas/PatchedConfigComplianceRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -59010,6 +91353,30 @@ paths:
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
@@ -59081,13 +91448,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/ConfigRemove'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/ConfigRemove'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/ConfigRemove'
+ $ref: '#/components/schemas/ConfigRemoveRequest'
required: true
security:
- cookieAuth: []
@@ -59108,13 +91469,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/ConfigRemove'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/ConfigRemove'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/ConfigRemove'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableConfigRemoveRequest'
required: true
security:
- cookieAuth: []
@@ -59124,7 +91481,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/ConfigRemove'
+ type: array
+ items:
+ $ref: '#/components/schemas/ConfigRemove'
description: ''
patch:
operationId: plugins_golden_config_config_remove_bulk_partial_update
@@ -59135,13 +91494,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedConfigRemove'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedConfigRemove'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedConfigRemove'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableConfigRemoveRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -59150,7 +91506,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/ConfigRemove'
+ type: array
+ items:
+ $ref: '#/components/schemas/ConfigRemove'
description: ''
delete:
operationId: plugins_golden_config_config_remove_bulk_destroy
@@ -59163,6 +91521,14 @@ paths:
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
@@ -59204,13 +91570,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/ConfigRemove'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/ConfigRemove'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/ConfigRemove'
+ $ref: '#/components/schemas/ConfigRemoveRequest'
required: true
security:
- cookieAuth: []
@@ -59239,13 +91599,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedConfigRemove'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedConfigRemove'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedConfigRemove'
+ $ref: '#/components/schemas/PatchedConfigRemoveRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -59346,13 +91700,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/ConfigReplace'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/ConfigReplace'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/ConfigReplace'
+ $ref: '#/components/schemas/ConfigReplaceRequest'
required: true
security:
- cookieAuth: []
@@ -59373,13 +91721,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/ConfigReplace'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/ConfigReplace'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/ConfigReplace'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableConfigReplaceRequest'
required: true
security:
- cookieAuth: []
@@ -59389,7 +91733,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/ConfigReplace'
+ type: array
+ items:
+ $ref: '#/components/schemas/ConfigReplace'
description: ''
patch:
operationId: plugins_golden_config_config_replace_bulk_partial_update
@@ -59400,13 +91746,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedConfigReplace'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedConfigReplace'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedConfigReplace'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableConfigReplaceRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -59415,7 +91758,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/ConfigReplace'
+ type: array
+ items:
+ $ref: '#/components/schemas/ConfigReplace'
description: ''
delete:
operationId: plugins_golden_config_config_replace_bulk_destroy
@@ -59428,6 +91773,14 @@ paths:
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
@@ -59469,13 +91822,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/ConfigReplace'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/ConfigReplace'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/ConfigReplace'
+ $ref: '#/components/schemas/ConfigReplaceRequest'
required: true
security:
- cookieAuth: []
@@ -59504,13 +91851,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedConfigReplace'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedConfigReplace'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedConfigReplace'
+ $ref: '#/components/schemas/PatchedConfigReplaceRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -59822,13 +92163,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/GoldenConfig'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/GoldenConfig'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/GoldenConfig'
+ $ref: '#/components/schemas/GoldenConfigRequest'
required: true
security:
- cookieAuth: []
@@ -59849,13 +92184,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/GoldenConfig'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/GoldenConfig'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/GoldenConfig'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableGoldenConfigRequest'
required: true
security:
- cookieAuth: []
@@ -59865,7 +92196,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/GoldenConfig'
+ type: array
+ items:
+ $ref: '#/components/schemas/GoldenConfig'
description: ''
patch:
operationId: plugins_golden_config_golden_config_bulk_partial_update
@@ -59876,13 +92209,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedGoldenConfig'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedGoldenConfig'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedGoldenConfig'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableGoldenConfigRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -59891,7 +92221,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/GoldenConfig'
+ type: array
+ items:
+ $ref: '#/components/schemas/GoldenConfig'
description: ''
delete:
operationId: plugins_golden_config_golden_config_bulk_destroy
@@ -59904,23 +92236,464 @@ paths:
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:
@@ -59942,13 +92715,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/GoldenConfigSetting'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/GoldenConfigSetting'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/GoldenConfigSetting'
+ $ref: '#/components/schemas/WritableGoldenConfigSettingRequest'
required: true
security:
- cookieAuth: []
@@ -59969,13 +92736,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/GoldenConfigSetting'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/GoldenConfigSetting'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/GoldenConfigSetting'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableGoldenConfigSettingRequest'
required: true
security:
- cookieAuth: []
@@ -59985,7 +92748,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/GoldenConfigSetting'
+ type: array
+ items:
+ $ref: '#/components/schemas/GoldenConfigSetting'
description: ''
patch:
operationId: plugins_golden_config_golden_config_settings_bulk_partial_update
@@ -59996,13 +92761,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedGoldenConfigSetting'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedGoldenConfigSetting'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedGoldenConfigSetting'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableGoldenConfigSettingRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -60011,7 +92773,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/GoldenConfigSetting'
+ type: array
+ items:
+ $ref: '#/components/schemas/GoldenConfigSetting'
description: ''
delete:
operationId: plugins_golden_config_golden_config_settings_bulk_destroy
@@ -60024,6 +92788,14 @@ paths:
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
@@ -60065,13 +92837,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/GoldenConfigSetting'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/GoldenConfigSetting'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/GoldenConfigSetting'
+ $ref: '#/components/schemas/WritableGoldenConfigSettingRequest'
required: true
security:
- cookieAuth: []
@@ -60100,13 +92866,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedGoldenConfigSetting'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedGoldenConfigSetting'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedGoldenConfigSetting'
+ $ref: '#/components/schemas/PatchedWritableGoldenConfigSettingRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -60177,13 +92937,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/GoldenConfig'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/GoldenConfig'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/GoldenConfig'
+ $ref: '#/components/schemas/GoldenConfigRequest'
required: true
security:
- cookieAuth: []
@@ -60212,13 +92966,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedGoldenConfig'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedGoldenConfig'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedGoldenConfig'
+ $ref: '#/components/schemas/PatchedGoldenConfigRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -60276,20 +93024,505 @@ paths:
- in: query
name: address
schema:
- type: string
+ 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: string
+ 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: email
+ 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
@@ -60299,7 +93532,115 @@ paths:
- in: query
name: name
schema:
- type: string
+ 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
@@ -60309,11 +93650,163 @@ paths:
- in: query
name: phone
schema:
- type: string
+ 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: integer
+ 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:
@@ -60322,7 +93815,115 @@ paths:
- in: query
name: type
schema:
- type: string
+ 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:
@@ -60344,13 +93945,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableContactLCM'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableContactLCM'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableContactLCM'
+ $ref: '#/components/schemas/WritableContactLCMRequest'
required: true
security:
- cookieAuth: []
@@ -60371,13 +93966,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableContactLCM'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableContactLCM'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableContactLCM'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableContactLCMRequest'
required: true
security:
- cookieAuth: []
@@ -60387,7 +93978,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/ContactLCM'
+ type: array
+ items:
+ $ref: '#/components/schemas/ContactLCM'
description: ''
patch:
operationId: plugins_nautobot_device_lifecycle_mgmt_contact_bulk_partial_update
@@ -60398,13 +93991,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableContactLCM'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableContactLCM'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableContactLCM'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableContactLCMRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -60413,7 +94003,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/ContactLCM'
+ type: array
+ items:
+ $ref: '#/components/schemas/ContactLCM'
description: ''
delete:
operationId: plugins_nautobot_device_lifecycle_mgmt_contact_bulk_destroy
@@ -60426,6 +94018,14 @@ paths:
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
@@ -60467,13 +94067,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableContactLCM'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableContactLCM'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableContactLCM'
+ $ref: '#/components/schemas/WritableContactLCMRequest'
required: true
security:
- cookieAuth: []
@@ -60502,13 +94096,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableContactLCM'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableContactLCM'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableContactLCM'
+ $ref: '#/components/schemas/PatchedWritableContactLCMRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -60546,11 +94134,178 @@ paths:
- in: query
name: contract_type
schema:
- type: string
+ 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: number
+ 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:
@@ -60571,6 +94326,147 @@ paths:
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
@@ -60580,7 +94476,115 @@ paths:
- in: query
name: name
schema:
- type: string
+ 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
@@ -60593,6 +94597,17 @@ paths:
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
@@ -60619,7 +94634,115 @@ paths:
- in: query
name: support_level
schema:
- type: string
+ 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:
@@ -60641,13 +94764,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableContractLCM'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableContractLCM'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableContractLCM'
+ $ref: '#/components/schemas/WritableContractLCMRequest'
required: true
security:
- cookieAuth: []
@@ -60668,13 +94785,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableContractLCM'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableContractLCM'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableContractLCM'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableContractLCMRequest'
required: true
security:
- cookieAuth: []
@@ -60684,7 +94797,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/ContractLCM'
+ type: array
+ items:
+ $ref: '#/components/schemas/ContractLCM'
description: ''
patch:
operationId: plugins_nautobot_device_lifecycle_mgmt_contract_bulk_partial_update
@@ -60695,13 +94810,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableContractLCM'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableContractLCM'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableContractLCM'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableContractLCMRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -60710,7 +94822,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/ContractLCM'
+ type: array
+ items:
+ $ref: '#/components/schemas/ContractLCM'
description: ''
delete:
operationId: plugins_nautobot_device_lifecycle_mgmt_contract_bulk_destroy
@@ -60723,6 +94837,14 @@ paths:
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
@@ -60764,13 +94886,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableContractLCM'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableContractLCM'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableContractLCM'
+ $ref: '#/components/schemas/WritableContractLCMRequest'
required: true
security:
- cookieAuth: []
@@ -60799,13 +94915,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableContractLCM'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableContractLCM'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableContractLCM'
+ $ref: '#/components/schemas/PatchedWritableContractLCMRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -60842,57 +94952,405 @@ paths:
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: number
- format: float
+ 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: number
- format: float
+ 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: number
- format: float
+ 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: number
- format: float
+ 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: number
- format: float
+ 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: number
- format: float
+ 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: number
- format: float
+ 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: number
- format: float
+ 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: number
- format: float
+ 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: string
+ 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:
@@ -60902,10 +95360,268 @@ paths:
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
@@ -60915,11 +95631,227 @@ paths:
- in: query
name: link
schema:
- type: string
+ 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: string
+ 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
@@ -60955,6 +95887,10 @@ paths:
name: severity
schema:
type: string
+ - in: query
+ name: severity__n
+ schema:
+ type: string
- in: query
name: status
schema:
@@ -60964,6 +95900,15 @@ paths:
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:
@@ -60972,6 +95917,14 @@ paths:
type: string
explode: true
style: form
+ - in: query
+ name: tag__n
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
tags:
- plugins
security:
@@ -60993,13 +95946,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/CVELCM'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/CVELCM'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/CVELCM'
+ $ref: '#/components/schemas/WritableCVELCMRequest'
required: true
security:
- cookieAuth: []
@@ -61020,13 +95967,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/CVELCM'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/CVELCM'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/CVELCM'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableCVELCMRequest'
required: true
security:
- cookieAuth: []
@@ -61036,7 +95979,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/CVELCM'
+ type: array
+ items:
+ $ref: '#/components/schemas/CVELCM'
description: ''
patch:
operationId: plugins_nautobot_device_lifecycle_mgmt_cve_bulk_partial_update
@@ -61047,13 +95992,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedCVELCM'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedCVELCM'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedCVELCM'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableCVELCMRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -61062,7 +96004,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/CVELCM'
+ type: array
+ items:
+ $ref: '#/components/schemas/CVELCM'
description: ''
delete:
operationId: plugins_nautobot_device_lifecycle_mgmt_cve_bulk_destroy
@@ -61075,6 +96019,14 @@ paths:
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
@@ -61116,13 +96068,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/CVELCM'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/CVELCM'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/CVELCM'
+ $ref: '#/components/schemas/WritableCVELCMRequest'
required: true
security:
- cookieAuth: []
@@ -61151,13 +96097,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedCVELCM'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedCVELCM'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedCVELCM'
+ $ref: '#/components/schemas/PatchedWritableCVELCMRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -61192,6 +96132,21 @@ paths:
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:
@@ -61201,6 +96156,15 @@ paths:
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:
@@ -61211,6 +96175,16 @@ paths:
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:
@@ -61280,6 +96254,132 @@ paths:
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:
@@ -61291,6 +96391,32 @@ paths:
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
@@ -61329,13 +96455,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableHardwareLCM'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableHardwareLCM'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableHardwareLCM'
+ $ref: '#/components/schemas/WritableHardwareLCMRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -61355,13 +96475,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableHardwareLCM'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableHardwareLCM'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableHardwareLCM'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableHardwareLCMRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -61370,7 +96487,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/HardwareLCM'
+ type: array
+ items:
+ $ref: '#/components/schemas/HardwareLCM'
description: ''
patch:
operationId: plugins_nautobot_device_lifecycle_mgmt_hardware_bulk_partial_update
@@ -61381,13 +96500,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableHardwareLCM'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableHardwareLCM'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableHardwareLCM'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableHardwareLCMRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -61396,7 +96512,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/HardwareLCM'
+ type: array
+ items:
+ $ref: '#/components/schemas/HardwareLCM'
description: ''
delete:
operationId: plugins_nautobot_device_lifecycle_mgmt_hardware_bulk_destroy
@@ -61409,6 +96527,14 @@ paths:
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
@@ -61450,13 +96576,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableHardwareLCM'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableHardwareLCM'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableHardwareLCM'
+ $ref: '#/components/schemas/WritableHardwareLCMRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -61484,13 +96604,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableHardwareLCM'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableHardwareLCM'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableHardwareLCM'
+ $ref: '#/components/schemas/PatchedWritableHardwareLCMRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -61529,19 +96643,607 @@ paths:
- in: query
name: comments
schema:
- type: string
+ 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: string
+ 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
@@ -61551,7 +97253,115 @@ paths:
- in: query
name: name
schema:
- type: string
+ 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
@@ -61561,15 +97371,339 @@ paths:
- in: query
name: phone
schema:
- type: string
+ 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: string
+ 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: string
+ 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:
@@ -61597,13 +97731,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/ProviderLCM'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/ProviderLCM'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/ProviderLCM'
+ $ref: '#/components/schemas/ProviderLCMRequest'
required: true
security:
- cookieAuth: []
@@ -61625,13 +97753,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/ProviderLCM'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/ProviderLCM'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/ProviderLCM'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableProviderLCMRequest'
required: true
security:
- cookieAuth: []
@@ -61641,7 +97765,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/ProviderLCM'
+ type: array
+ items:
+ $ref: '#/components/schemas/ProviderLCM'
description: ''
patch:
operationId: plugins_nautobot_device_lifecycle_mgmt_provider_bulk_partial_update
@@ -61653,13 +97779,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedProviderLCM'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedProviderLCM'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedProviderLCM'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableProviderLCMRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -61668,7 +97791,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/ProviderLCM'
+ type: array
+ items:
+ $ref: '#/components/schemas/ProviderLCM'
description: ''
delete:
operationId: plugins_nautobot_device_lifecycle_mgmt_provider_bulk_destroy
@@ -61682,6 +97807,14 @@ paths:
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
@@ -61725,13 +97858,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/ProviderLCM'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/ProviderLCM'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/ProviderLCM'
+ $ref: '#/components/schemas/ProviderLCMRequest'
required: true
security:
- cookieAuth: []
@@ -61761,13 +97888,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedProviderLCM'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedProviderLCM'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedProviderLCM'
+ $ref: '#/components/schemas/PatchedProviderLCMRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -61805,8 +97926,131 @@ paths:
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:
@@ -61816,6 +98060,15 @@ paths:
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:
@@ -61830,6 +98083,147 @@ paths:
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
@@ -61868,7 +98262,115 @@ paths:
- in: query
name: version
schema:
- type: string
+ 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:
@@ -61890,13 +98392,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableSoftwareLCM'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableSoftwareLCM'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableSoftwareLCM'
+ $ref: '#/components/schemas/WritableSoftwareLCMRequest'
required: true
security:
- cookieAuth: []
@@ -61917,13 +98413,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableSoftwareLCM'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableSoftwareLCM'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableSoftwareLCM'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableSoftwareLCMRequest'
required: true
security:
- cookieAuth: []
@@ -61933,7 +98425,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/SoftwareLCM'
+ type: array
+ items:
+ $ref: '#/components/schemas/SoftwareLCM'
description: ''
patch:
operationId: plugins_nautobot_device_lifecycle_mgmt_software_bulk_partial_update
@@ -61944,13 +98438,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableSoftwareLCM'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableSoftwareLCM'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableSoftwareLCM'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableSoftwareLCMRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -61959,7 +98450,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/SoftwareLCM'
+ type: array
+ items:
+ $ref: '#/components/schemas/SoftwareLCM'
description: ''
delete:
operationId: plugins_nautobot_device_lifecycle_mgmt_software_bulk_destroy
@@ -61972,11 +98465,34 @@ paths:
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:
@@ -62000,6 +98516,15 @@ paths:
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:
@@ -62010,18 +98535,478 @@ paths:
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: string
+ 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: string
+ 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: string
+ 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:
@@ -62037,6 +99022,16 @@ paths:
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:
@@ -62047,6 +99042,31 @@ paths:
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
@@ -62062,6 +99082,15 @@ paths:
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:
@@ -62072,6 +99101,16 @@ paths:
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
@@ -62093,6 +99132,16 @@ paths:
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:
@@ -62102,6 +99151,15 @@ paths:
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:
@@ -62123,13 +99181,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableSoftwareImageLCM'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableSoftwareImageLCM'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableSoftwareImageLCM'
+ $ref: '#/components/schemas/WritableSoftwareImageLCMRequest'
required: true
security:
- cookieAuth: []
@@ -62150,13 +99202,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableSoftwareImageLCM'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableSoftwareImageLCM'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableSoftwareImageLCM'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableSoftwareImageLCMRequest'
required: true
security:
- cookieAuth: []
@@ -62166,7 +99214,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/SoftwareImageLCM'
+ type: array
+ items:
+ $ref: '#/components/schemas/SoftwareImageLCM'
description: ''
patch:
operationId: plugins_nautobot_device_lifecycle_mgmt_software_image_bulk_partial_update
@@ -62177,13 +99227,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableSoftwareImageLCM'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableSoftwareImageLCM'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableSoftwareImageLCM'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableSoftwareImageLCMRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -62192,7 +99239,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/SoftwareImageLCM'
+ type: array
+ items:
+ $ref: '#/components/schemas/SoftwareImageLCM'
description: ''
delete:
operationId: plugins_nautobot_device_lifecycle_mgmt_software_image_bulk_destroy
@@ -62205,6 +99254,14 @@ paths:
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
@@ -62246,13 +99303,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableSoftwareImageLCM'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableSoftwareImageLCM'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableSoftwareImageLCM'
+ $ref: '#/components/schemas/WritableSoftwareImageLCMRequest'
required: true
security:
- cookieAuth: []
@@ -62281,13 +99332,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableSoftwareImageLCM'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableSoftwareImageLCM'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableSoftwareImageLCM'
+ $ref: '#/components/schemas/PatchedWritableSoftwareImageLCMRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -62358,13 +99403,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableSoftwareLCM'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableSoftwareLCM'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableSoftwareLCM'
+ $ref: '#/components/schemas/WritableSoftwareLCMRequest'
required: true
security:
- cookieAuth: []
@@ -62393,13 +99432,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableSoftwareLCM'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableSoftwareLCM'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableSoftwareLCM'
+ $ref: '#/components/schemas/PatchedWritableSoftwareLCMRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -62434,6 +99467,21 @@ paths:
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:
@@ -62453,6 +99501,15 @@ paths:
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:
@@ -62463,6 +99520,16 @@ paths:
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:
@@ -62472,6 +99539,15 @@ paths:
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:
@@ -62482,6 +99558,16 @@ paths:
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:
@@ -62492,6 +99578,16 @@ paths:
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:
@@ -62502,6 +99598,16 @@ paths:
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:
@@ -62512,6 +99618,132 @@ paths:
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:
@@ -62526,6 +99758,15 @@ paths:
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:
@@ -62536,6 +99777,31 @@ paths:
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
@@ -62551,6 +99817,15 @@ paths:
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:
@@ -62561,6 +99836,16 @@ paths:
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
@@ -62586,6 +99871,16 @@ paths:
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:
@@ -62622,13 +99917,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableValidatedSoftwareLCM'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableValidatedSoftwareLCM'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableValidatedSoftwareLCM'
+ $ref: '#/components/schemas/WritableValidatedSoftwareLCMRequest'
required: true
security:
- cookieAuth: []
@@ -62649,13 +99938,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableValidatedSoftwareLCM'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableValidatedSoftwareLCM'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableValidatedSoftwareLCM'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableValidatedSoftwareLCMRequest'
required: true
security:
- cookieAuth: []
@@ -62665,7 +99950,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/ValidatedSoftwareLCM'
+ type: array
+ items:
+ $ref: '#/components/schemas/ValidatedSoftwareLCM'
description: ''
patch:
operationId: plugins_nautobot_device_lifecycle_mgmt_validated_software_bulk_partial_update
@@ -62676,13 +99963,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableValidatedSoftwareLCM'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableValidatedSoftwareLCM'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableValidatedSoftwareLCM'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableValidatedSoftwareLCMRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -62691,7 +99975,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/ValidatedSoftwareLCM'
+ type: array
+ items:
+ $ref: '#/components/schemas/ValidatedSoftwareLCM'
description: ''
delete:
operationId: plugins_nautobot_device_lifecycle_mgmt_validated_software_bulk_destroy
@@ -62704,6 +99990,14 @@ paths:
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
@@ -62745,13 +100039,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableValidatedSoftwareLCM'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableValidatedSoftwareLCM'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableValidatedSoftwareLCM'
+ $ref: '#/components/schemas/WritableValidatedSoftwareLCMRequest'
required: true
security:
- cookieAuth: []
@@ -62780,13 +100068,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableValidatedSoftwareLCM'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableValidatedSoftwareLCM'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableValidatedSoftwareLCM'
+ $ref: '#/components/schemas/PatchedWritableValidatedSoftwareLCMRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -62821,11 +100103,31 @@ paths:
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:
@@ -62851,6 +100153,11 @@ paths:
schema:
type: string
format: uuid
+ - in: query
+ name: device__n
+ schema:
+ type: string
+ format: uuid
- in: query
name: exclude_status
schema:
@@ -62860,11 +100167,166 @@ paths:
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
@@ -62887,6 +100349,11 @@ paths:
schema:
type: string
format: uuid
+ - in: query
+ name: software__n
+ schema:
+ type: string
+ format: uuid
- in: query
name: status
schema:
@@ -62896,6 +100363,15 @@ paths:
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:
@@ -62904,6 +100380,14 @@ paths:
type: string
explode: true
style: form
+ - in: query
+ name: tag__n
+ schema:
+ type: array
+ items:
+ type: string
+ explode: true
+ style: form
tags:
- plugins
security:
@@ -62925,13 +100409,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/VulnerabilityLCM'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/VulnerabilityLCM'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/VulnerabilityLCM'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableVulnerabilityLCMRequest'
required: true
security:
- cookieAuth: []
@@ -62941,7 +100421,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/VulnerabilityLCM'
+ type: array
+ items:
+ $ref: '#/components/schemas/VulnerabilityLCM'
description: ''
patch:
operationId: plugins_nautobot_device_lifecycle_mgmt_vulnerability_bulk_partial_update
@@ -62952,13 +100434,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedVulnerabilityLCM'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedVulnerabilityLCM'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedVulnerabilityLCM'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableVulnerabilityLCMRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -62967,7 +100446,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/VulnerabilityLCM'
+ type: array
+ items:
+ $ref: '#/components/schemas/VulnerabilityLCM'
description: ''
delete:
operationId: plugins_nautobot_device_lifecycle_mgmt_vulnerability_bulk_destroy
@@ -62980,6 +100461,14 @@ paths:
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
@@ -63021,13 +100510,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/VulnerabilityLCM'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/VulnerabilityLCM'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/VulnerabilityLCM'
+ $ref: '#/components/schemas/VulnerabilityLCMRequest'
required: true
security:
- cookieAuth: []
@@ -63056,13 +100539,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedVulnerabilityLCM'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedVulnerabilityLCM'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedVulnerabilityLCM'
+ $ref: '#/components/schemas/PatchedVulnerabilityLCMRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -63526,8 +101003,10 @@ paths:
/tenancy/tenant-groups/:
get:
operationId: tenancy_tenant_groups_list
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -64092,21 +101571,17 @@ paths:
description: ''
post:
operationId: tenancy_tenant_groups_create
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritableTenantGroup'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableTenantGroup'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableTenantGroup'
+ $ref: '#/components/schemas/WritableTenantGroupRequest'
required: true
security:
- cookieAuth: []
@@ -64120,21 +101595,19 @@ paths:
description: ''
put:
operationId: tenancy_tenant_groups_bulk_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritableTenantGroup'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableTenantGroup'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableTenantGroup'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableTenantGroupRequest'
required: true
security:
- cookieAuth: []
@@ -64144,25 +101617,26 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/TenantGroup'
+ type: array
+ items:
+ $ref: '#/components/schemas/TenantGroup'
description: ''
patch:
operationId: tenancy_tenant_groups_bulk_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/PatchedWritableTenantGroup'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableTenantGroup'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableTenantGroup'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableTenantGroupRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -64171,12 +101645,16 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/TenantGroup'
+ type: array
+ items:
+ $ref: '#/components/schemas/TenantGroup'
description: ''
delete:
operationId: tenancy_tenant_groups_bulk_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -64185,11 +101663,21 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -64212,8 +101700,10 @@ paths:
description: ''
put:
operationId: tenancy_tenant_groups_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -64228,13 +101718,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableTenantGroup'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableTenantGroup'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableTenantGroup'
+ $ref: '#/components/schemas/WritableTenantGroupRequest'
required: true
security:
- cookieAuth: []
@@ -64248,8 +101732,10 @@ paths:
description: ''
patch:
operationId: tenancy_tenant_groups_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -64264,13 +101750,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableTenantGroup'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableTenantGroup'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableTenantGroup'
+ $ref: '#/components/schemas/PatchedWritableTenantGroupRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -64283,8 +101763,10 @@ paths:
description: ''
delete:
operationId: tenancy_tenant_groups_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -64301,11 +101783,78 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -64362,6 +101911,11 @@ paths:
description: Tenant group (ID)
explode: true
style: form
+ - in: query
+ name: has_locations
+ schema:
+ type: boolean
+ description: Has locations
- in: query
name: id
schema:
@@ -64509,6 +102063,26 @@ paths:
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:
@@ -64774,21 +102348,17 @@ paths:
description: ''
post:
operationId: tenancy_tenants_create
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritableTenant'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableTenant'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableTenant'
+ $ref: '#/components/schemas/WritableTenantRequest'
required: true
security:
- cookieAuth: []
@@ -64802,21 +102372,19 @@ paths:
description: ''
put:
operationId: tenancy_tenants_bulk_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritableTenant'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableTenant'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableTenant'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableTenantRequest'
required: true
security:
- cookieAuth: []
@@ -64826,25 +102394,26 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/Tenant'
+ type: array
+ items:
+ $ref: '#/components/schemas/Tenant'
description: ''
patch:
operationId: tenancy_tenants_bulk_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/PatchedWritableTenant'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableTenant'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableTenant'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableTenantRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -64853,12 +102422,16 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/Tenant'
+ type: array
+ items:
+ $ref: '#/components/schemas/Tenant'
description: ''
delete:
operationId: tenancy_tenants_bulk_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -64867,11 +102440,21 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -64894,8 +102477,10 @@ paths:
description: ''
put:
operationId: tenancy_tenants_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -64910,13 +102495,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableTenant'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableTenant'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableTenant'
+ $ref: '#/components/schemas/WritableTenantRequest'
required: true
security:
- cookieAuth: []
@@ -64930,8 +102509,10 @@ paths:
description: ''
patch:
operationId: tenancy_tenants_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -64946,13 +102527,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableTenant'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableTenant'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableTenant'
+ $ref: '#/components/schemas/PatchedWritableTenantRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -64965,8 +102540,10 @@ paths:
description: ''
delete:
operationId: tenancy_tenants_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -64983,6 +102560,71 @@ paths:
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
@@ -65203,13 +102845,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Group'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/Group'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/Group'
+ $ref: '#/components/schemas/GroupRequest'
required: true
security:
- cookieAuth: []
@@ -65230,13 +102866,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Group'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/Group'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/Group'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableGroupRequest'
required: true
security:
- cookieAuth: []
@@ -65246,7 +102878,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/Group'
+ type: array
+ items:
+ $ref: '#/components/schemas/Group'
description: ''
patch:
operationId: users_groups_bulk_partial_update
@@ -65257,13 +102891,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedGroup'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedGroup'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedGroup'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableGroupRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -65272,7 +102903,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/Group'
+ type: array
+ items:
+ $ref: '#/components/schemas/Group'
description: ''
delete:
operationId: users_groups_bulk_destroy
@@ -65285,6 +102918,14 @@ paths:
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
@@ -65324,13 +102965,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Group'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/Group'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/Group'
+ $ref: '#/components/schemas/GroupRequest'
required: true
security:
- cookieAuth: []
@@ -65358,13 +102993,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedGroup'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedGroup'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedGroup'
+ $ref: '#/components/schemas/PatchedGroupRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -65763,13 +103392,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableObjectPermission'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableObjectPermission'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableObjectPermission'
+ $ref: '#/components/schemas/WritableObjectPermissionRequest'
required: true
security:
- cookieAuth: []
@@ -65790,13 +103413,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableObjectPermission'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableObjectPermission'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableObjectPermission'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableObjectPermissionRequest'
required: true
security:
- cookieAuth: []
@@ -65806,7 +103425,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/ObjectPermission'
+ type: array
+ items:
+ $ref: '#/components/schemas/ObjectPermission'
description: ''
patch:
operationId: users_permissions_bulk_partial_update
@@ -65817,13 +103438,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableObjectPermission'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableObjectPermission'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableObjectPermission'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableObjectPermissionRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -65832,7 +103450,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/ObjectPermission'
+ type: array
+ items:
+ $ref: '#/components/schemas/ObjectPermission'
description: ''
delete:
operationId: users_permissions_bulk_destroy
@@ -65845,6 +103465,14 @@ paths:
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
@@ -65886,13 +103514,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableObjectPermission'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableObjectPermission'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableObjectPermission'
+ $ref: '#/components/schemas/WritableObjectPermissionRequest'
required: true
security:
- cookieAuth: []
@@ -65921,13 +103543,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableObjectPermission'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableObjectPermission'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableObjectPermission'
+ $ref: '#/components/schemas/PatchedWritableObjectPermissionRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -66351,13 +103967,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Token'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/Token'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/Token'
+ $ref: '#/components/schemas/TokenRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -66378,13 +103988,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Token'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/Token'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/Token'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableTokenRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -66394,7 +104001,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/Token'
+ type: array
+ items:
+ $ref: '#/components/schemas/Token'
description: ''
patch:
operationId: users_tokens_bulk_partial_update
@@ -66405,13 +104014,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedToken'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedToken'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedToken'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableTokenRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -66421,7 +104027,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/Token'
+ type: array
+ items:
+ $ref: '#/components/schemas/Token'
description: ''
delete:
operationId: users_tokens_bulk_destroy
@@ -66435,6 +104043,14 @@ paths:
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
@@ -66477,13 +104093,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/Token'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/Token'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/Token'
+ $ref: '#/components/schemas/TokenRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -66512,13 +104122,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedToken'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedToken'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedToken'
+ $ref: '#/components/schemas/PatchedTokenRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -67211,13 +104815,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableUser'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableUser'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableUser'
+ $ref: '#/components/schemas/WritableUserRequest'
required: true
security:
- cookieAuth: []
@@ -67238,13 +104836,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableUser'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableUser'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableUser'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableUserRequest'
required: true
security:
- cookieAuth: []
@@ -67254,7 +104848,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/User'
+ type: array
+ items:
+ $ref: '#/components/schemas/User'
description: ''
patch:
operationId: users_users_bulk_partial_update
@@ -67265,13 +104861,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableUser'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableUser'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableUser'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableUserRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -67280,7 +104873,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/User'
+ type: array
+ items:
+ $ref: '#/components/schemas/User'
description: ''
delete:
operationId: users_users_bulk_destroy
@@ -67293,6 +104888,14 @@ paths:
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
@@ -67334,13 +104937,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableUser'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableUser'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableUser'
+ $ref: '#/components/schemas/WritableUserRequest'
required: true
security:
- cookieAuth: []
@@ -67369,13 +104966,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableUser'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableUser'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableUser'
+ $ref: '#/components/schemas/PatchedWritableUserRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -67408,9 +104999,31 @@ paths:
/virtualization/cluster-groups/:
get:
operationId: virtualization_cluster_groups_list
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -67538,6 +105151,11 @@ paths:
type: string
explode: true
style: form
+ - in: query
+ name: has_clusters
+ schema:
+ type: boolean
+ description: Has clusters
- in: query
name: id
schema:
@@ -67934,21 +105552,17 @@ paths:
description: ''
post:
operationId: virtualization_cluster_groups_create
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/ClusterGroup'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/ClusterGroup'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/ClusterGroup'
+ $ref: '#/components/schemas/ClusterGroupRequest'
required: true
security:
- cookieAuth: []
@@ -67962,21 +105576,19 @@ paths:
description: ''
put:
operationId: virtualization_cluster_groups_bulk_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/ClusterGroup'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/ClusterGroup'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/ClusterGroup'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableClusterGroupRequest'
required: true
security:
- cookieAuth: []
@@ -67986,25 +105598,26 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/ClusterGroup'
+ type: array
+ items:
+ $ref: '#/components/schemas/ClusterGroup'
description: ''
patch:
operationId: virtualization_cluster_groups_bulk_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/PatchedClusterGroup'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedClusterGroup'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedClusterGroup'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableClusterGroupRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -68013,12 +105626,16 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/ClusterGroup'
+ type: array
+ items:
+ $ref: '#/components/schemas/ClusterGroup'
description: ''
delete:
operationId: virtualization_cluster_groups_bulk_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -68027,11 +105644,21 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -68054,8 +105681,10 @@ paths:
description: ''
put:
operationId: virtualization_cluster_groups_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -68070,13 +105699,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/ClusterGroup'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/ClusterGroup'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/ClusterGroup'
+ $ref: '#/components/schemas/ClusterGroupRequest'
required: true
security:
- cookieAuth: []
@@ -68090,8 +105713,10 @@ paths:
description: ''
patch:
operationId: virtualization_cluster_groups_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -68106,13 +105731,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedClusterGroup'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedClusterGroup'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedClusterGroup'
+ $ref: '#/components/schemas/PatchedClusterGroupRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -68125,8 +105744,10 @@ paths:
description: ''
delete:
operationId: virtualization_cluster_groups_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -68143,12 +105764,99 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -68276,6 +105984,11 @@ paths:
type: string
explode: true
style: form
+ - in: query
+ name: has_clusters
+ schema:
+ type: boolean
+ description: Has clusters
- in: query
name: id
schema:
@@ -68672,21 +106385,17 @@ paths:
description: ''
post:
operationId: virtualization_cluster_types_create
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/ClusterType'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/ClusterType'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/ClusterType'
+ $ref: '#/components/schemas/ClusterTypeRequest'
required: true
security:
- cookieAuth: []
@@ -68700,21 +106409,19 @@ paths:
description: ''
put:
operationId: virtualization_cluster_types_bulk_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/ClusterType'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/ClusterType'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/ClusterType'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableClusterTypeRequest'
required: true
security:
- cookieAuth: []
@@ -68724,25 +106431,26 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/ClusterType'
+ type: array
+ items:
+ $ref: '#/components/schemas/ClusterType'
description: ''
patch:
operationId: virtualization_cluster_types_bulk_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/PatchedClusterType'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedClusterType'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedClusterType'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableClusterTypeRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -68751,12 +106459,16 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/ClusterType'
+ type: array
+ items:
+ $ref: '#/components/schemas/ClusterType'
description: ''
delete:
operationId: virtualization_cluster_types_bulk_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -68765,11 +106477,21 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -68792,8 +106514,10 @@ paths:
description: ''
put:
operationId: virtualization_cluster_types_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -68808,13 +106532,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/ClusterType'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/ClusterType'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/ClusterType'
+ $ref: '#/components/schemas/ClusterTypeRequest'
required: true
security:
- cookieAuth: []
@@ -68828,8 +106546,10 @@ paths:
description: ''
patch:
operationId: virtualization_cluster_types_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -68844,13 +106564,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedClusterType'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedClusterType'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedClusterType'
+ $ref: '#/components/schemas/PatchedClusterTypeRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -68863,8 +106577,10 @@ paths:
description: ''
delete:
operationId: virtualization_cluster_types_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -68881,12 +106597,191 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -68902,6 +106797,26 @@ paths:
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:
@@ -68942,6 +106857,16 @@ paths:
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:
@@ -69089,6 +107014,26 @@ paths:
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:
@@ -69219,7 +107164,7 @@ paths:
items:
type: string
format: uuid
- description: Region (slug)
+ description: Region (slug or ID)
explode: true
style: form
- in: query
@@ -69229,7 +107174,7 @@ paths:
items:
type: string
format: uuid
- description: Region (slug)
+ description: Region (slug or ID)
explode: true
style: form
- in: query
@@ -69239,7 +107184,7 @@ paths:
items:
type: string
format: uuid
- description: Region (ID)
+ description: Region (ID) (deprecated, use "region" filter instead)
explode: true
style: form
- in: query
@@ -69249,7 +107194,7 @@ paths:
items:
type: string
format: uuid
- description: Region (ID)
+ description: Region (ID) (deprecated, use "region" filter instead)
explode: true
style: form
- in: query
@@ -69258,7 +107203,8 @@ paths:
type: array
items:
type: string
- description: Site (slug)
+ format: uuid
+ description: Site (slug or ID)
explode: true
style: form
- in: query
@@ -69267,7 +107213,8 @@ paths:
type: array
items:
type: string
- description: Site (slug)
+ format: uuid
+ description: Site (slug or ID)
explode: true
style: form
- in: query
@@ -69278,7 +107225,7 @@ paths:
type: string
format: uuid
nullable: true
- description: Site (ID)
+ description: Site (ID) (deprecated, use "site" filter instead)
explode: true
style: form
- in: query
@@ -69289,7 +107236,7 @@ paths:
type: string
format: uuid
nullable: true
- description: Site (ID)
+ description: Site (ID) (deprecated, use "site" filter instead)
explode: true
style: form
- in: query
@@ -69314,7 +107261,8 @@ paths:
type: array
items:
type: string
- description: Tenant (slug)
+ format: uuid
+ description: Tenant (slug or ID)
explode: true
style: form
- in: query
@@ -69323,7 +107271,8 @@ paths:
type: array
items:
type: string
- description: Tenant (slug)
+ format: uuid
+ description: Tenant (slug or ID)
explode: true
style: form
- in: query
@@ -69374,7 +107323,7 @@ paths:
type: string
format: uuid
nullable: true
- description: Tenant (ID)
+ description: Tenant (ID) (deprecated, use "tenant" filter instead)
explode: true
style: form
- in: query
@@ -69385,7 +107334,7 @@ paths:
type: string
format: uuid
nullable: true
- description: Tenant (ID)
+ description: Tenant (ID) (deprecated, use "tenant" filter instead)
explode: true
style: form
- in: query
@@ -69426,6 +107375,26 @@ paths:
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:
@@ -69440,21 +107409,17 @@ paths:
description: ''
post:
operationId: virtualization_clusters_create
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritableCluster'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableCluster'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableCluster'
+ $ref: '#/components/schemas/WritableClusterRequest'
required: true
security:
- cookieAuth: []
@@ -69468,21 +107433,19 @@ paths:
description: ''
put:
operationId: virtualization_clusters_bulk_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/WritableCluster'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableCluster'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableCluster'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableClusterRequest'
required: true
security:
- cookieAuth: []
@@ -69492,25 +107455,26 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/Cluster'
+ type: array
+ items:
+ $ref: '#/components/schemas/Cluster'
description: ''
patch:
operationId: virtualization_clusters_bulk_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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/PatchedWritableCluster'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableCluster'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableCluster'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableClusterRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -69519,12 +107483,16 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/Cluster'
+ type: array
+ items:
+ $ref: '#/components/schemas/Cluster'
description: ''
delete:
operationId: virtualization_clusters_bulk_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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:
@@ -69533,11 +107501,21 @@ paths:
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: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -69560,8 +107538,10 @@ paths:
description: ''
put:
operationId: virtualization_clusters_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -69576,13 +107556,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableCluster'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableCluster'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableCluster'
+ $ref: '#/components/schemas/WritableClusterRequest'
required: true
security:
- cookieAuth: []
@@ -69596,8 +107570,10 @@ paths:
description: ''
patch:
operationId: virtualization_clusters_partial_update
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -69612,13 +107588,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableCluster'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableCluster'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableCluster'
+ $ref: '#/components/schemas/PatchedWritableClusterRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -69631,8 +107601,10 @@ paths:
description: ''
delete:
operationId: virtualization_clusters_destroy
- description: Include the applicable set of CustomFields in the ModelViewSet
- context.
+ description: |-
+ Base class to 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
@@ -69649,11 +107621,137 @@ paths:
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: Extend DRF's ModelViewSet to support bulk update and delete functions.
+ 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:
@@ -69692,10 +107790,142 @@ paths:
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:
@@ -69822,6 +108052,15 @@ paths:
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
@@ -69968,6 +108207,14 @@ paths:
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:
@@ -70134,11 +108381,49 @@ paths:
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:
@@ -70155,6 +108440,46 @@ paths:
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:
@@ -70203,24 +108528,19 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/PaginatedVMInterfaceList'
+ $ref: '#/components/schemas/PaginatedVMInterfaceSerializerVersion12List'
description: ''
post:
operationId: virtualization_interfaces_create
- description: Extend DRF's ModelViewSet to support bulk update and delete functions.
+ description: Mixin to set `metadata_class` to implement `status` field in model
+ viewset metadata.
tags:
- virtualization
requestBody:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableVMInterface'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableVMInterface'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableVMInterface'
+ $ref: '#/components/schemas/WritableVMInterfaceRequest'
required: true
security:
- cookieAuth: []
@@ -70230,24 +108550,21 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/VMInterface'
+ $ref: '#/components/schemas/VMInterfaceSerializerVersion12'
description: ''
put:
operationId: virtualization_interfaces_bulk_update
- description: Extend DRF's ModelViewSet to support bulk update and delete functions.
+ description: Mixin to set `metadata_class` to implement `status` field in model
+ viewset metadata.
tags:
- virtualization
requestBody:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableVMInterface'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableVMInterface'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableVMInterface'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableVMInterfaceRequest'
required: true
security:
- cookieAuth: []
@@ -70257,24 +108574,24 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/VMInterface'
+ type: array
+ items:
+ $ref: '#/components/schemas/VMInterfaceSerializerVersion12'
description: ''
patch:
operationId: virtualization_interfaces_bulk_partial_update
- description: Extend DRF's ModelViewSet to support bulk update and delete functions.
+ description: Mixin to set `metadata_class` to implement `status` field in model
+ viewset metadata.
tags:
- virtualization
requestBody:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableVMInterface'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableVMInterface'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableVMInterface'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableVMInterfaceRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -70283,11 +108600,14 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/VMInterface'
+ type: array
+ items:
+ $ref: '#/components/schemas/VMInterfaceSerializerVersion12'
description: ''
delete:
operationId: virtualization_interfaces_bulk_destroy
- description: Extend DRF's ModelViewSet to support bulk update and delete functions.
+ description: Mixin to set `metadata_class` to implement `status` field in model
+ viewset metadata.
tags:
- virtualization
security:
@@ -70296,10 +108616,19 @@ paths:
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: Extend DRF's ModelViewSet to support bulk update and delete functions.
+ description: Mixin to set `metadata_class` to implement `status` field in model
+ viewset metadata.
parameters:
- in: path
name: id
@@ -70318,11 +108647,12 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/VMInterface'
+ $ref: '#/components/schemas/VMInterfaceSerializerVersion12'
description: ''
put:
operationId: virtualization_interfaces_update
- description: Extend DRF's ModelViewSet to support bulk update and delete functions.
+ description: Mixin to set `metadata_class` to implement `status` field in model
+ viewset metadata.
parameters:
- in: path
name: id
@@ -70337,13 +108667,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableVMInterface'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableVMInterface'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableVMInterface'
+ $ref: '#/components/schemas/WritableVMInterfaceRequest'
required: true
security:
- cookieAuth: []
@@ -70353,11 +108677,12 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/VMInterface'
+ $ref: '#/components/schemas/VMInterfaceSerializerVersion12'
description: ''
patch:
operationId: virtualization_interfaces_partial_update
- description: Extend DRF's ModelViewSet to support bulk update and delete functions.
+ description: Mixin to set `metadata_class` to implement `status` field in model
+ viewset metadata.
parameters:
- in: path
name: id
@@ -70372,13 +108697,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableVMInterface'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableVMInterface'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableVMInterface'
+ $ref: '#/components/schemas/PatchedWritableVMInterfaceRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -70387,11 +108706,12 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/VMInterface'
+ $ref: '#/components/schemas/VMInterfaceSerializerVersion12'
description: ''
delete:
operationId: virtualization_interfaces_destroy
- description: Extend DRF's ModelViewSet to support bulk update and delete functions.
+ description: Mixin to set `metadata_class` to implement `status` field in model
+ viewset metadata.
parameters:
- in: path
name: id
@@ -70408,6 +108728,71 @@ paths:
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
@@ -70416,1003 +108801,840 @@ paths:
Provides a get_queryset() method which deals with adding the config context
data annotation or not.
parameters:
- - in: query
- name: cluster
+ - name: cluster
+ required: false
+ in: query
+ description: cluster
schema:
type: string
- format: uuid
- - in: query
- name: cluster__n
+ - name: cluster__n
+ required: false
+ in: query
+ description: cluster__n
schema:
type: string
- format: uuid
- - in: query
- name: cluster_group
- schema:
- type: array
- items:
- type: string
+ - name: cluster_group
+ required: false
+ in: query
description: Cluster group (slug)
- explode: true
- style: form
- - in: query
- name: cluster_group__n
schema:
- type: array
- items:
- type: string
+ type: string
+ - name: cluster_group__n
+ required: false
+ in: query
description: Cluster group (slug)
- explode: true
- style: form
- - in: query
- name: cluster_group_id
schema:
- type: array
- items:
- type: string
- format: uuid
+ type: string
+ - name: cluster_group_id
+ required: false
+ in: query
description: Cluster group (ID)
- explode: true
- style: form
- - in: query
- name: cluster_group_id__n
schema:
- type: array
- items:
- type: string
- format: uuid
+ type: string
+ - name: cluster_group_id__n
+ required: false
+ in: query
description: Cluster group (ID)
- explode: true
- style: form
- - in: query
- name: cluster_id
schema:
- type: array
- items:
- type: string
- format: uuid
+ type: string
+ - name: cluster_id
+ required: false
+ in: query
description: Cluster (ID)
- explode: true
- style: form
- - in: query
- name: cluster_id__n
schema:
- type: array
- items:
- type: string
- format: uuid
+ type: string
+ - name: cluster_id__n
+ required: false
+ in: query
description: Cluster (ID)
- explode: true
- style: form
- - in: query
- name: cluster_type
schema:
- type: array
- items:
- type: string
+ type: string
+ - name: cluster_type
+ required: false
+ in: query
description: Cluster type (slug)
- explode: true
- style: form
- - in: query
- name: cluster_type__n
schema:
- type: array
- items:
- type: string
+ type: string
+ - name: cluster_type__n
+ required: false
+ in: query
description: Cluster type (slug)
- explode: true
- style: form
- - in: query
- name: cluster_type_id
schema:
- type: array
- items:
- type: string
- format: uuid
+ type: string
+ - name: cluster_type_id
+ required: false
+ in: query
description: Cluster type (ID)
- explode: true
- style: form
- - in: query
- name: cluster_type_id__n
schema:
- type: array
- items:
- type: string
- format: uuid
+ type: string
+ - name: cluster_type_id__n
+ required: false
+ in: query
description: Cluster type (ID)
- explode: true
- style: form
- - in: query
- name: created
schema:
type: string
- format: date
- - in: query
- name: created__gte
+ - name: comments
+ required: false
+ in: query
+ description: comments
schema:
type: string
- format: date
- - in: query
- name: created__lte
+ - name: comments__ic
+ required: false
+ in: query
+ description: comments__ic
schema:
type: string
- format: date
- - in: query
- name: disk
+ - name: comments__ie
+ required: false
+ in: query
+ description: comments__ie
schema:
- type: array
- items:
- type: integer
- explode: true
- style: form
- - in: query
- name: disk__gt
+ type: string
+ - name: comments__iew
+ required: false
+ in: query
+ description: comments__iew
schema:
- type: array
- items:
- type: integer
- explode: true
- style: form
- - in: query
- name: disk__gte
+ type: string
+ - name: comments__ire
+ required: false
+ in: query
+ description: comments__ire
schema:
- type: array
- items:
- type: integer
- explode: true
- style: form
- - in: query
- name: disk__lt
+ type: string
+ - name: comments__isw
+ required: false
+ in: query
+ description: comments__isw
schema:
- type: array
- items:
- type: integer
- explode: true
- style: form
- - in: query
- name: disk__lte
+ type: string
+ - name: comments__n
+ required: false
+ in: query
+ description: comments__n
schema:
- type: array
- items:
- type: integer
- explode: true
- style: form
- - in: query
- name: disk__n
+ type: string
+ - name: comments__nic
+ required: false
+ in: query
+ description: comments__nic
schema:
- type: array
- items:
- type: integer
- explode: true
- style: form
- - in: query
- name: has_primary_ip
+ type: string
+ - name: comments__nie
+ required: false
+ in: query
+ description: comments__nie
schema:
- type: boolean
+ 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
- - 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
+ - name: has_services
+ required: false
+ in: query
+ description: Has services
schema:
type: string
- format: date-time
- - in: query
- name: last_updated__lte
+ - 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
- format: date-time
- name: limit
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- - in: query
- name: local_context_data
- schema:
- type: boolean
+ - name: local_context_data
+ required: false
+ in: query
description: Has local config context data
- - in: query
- name: local_context_schema
schema:
- type: array
- items:
- type: string
+ type: string
+ - name: local_context_schema
+ required: false
+ in: query
description: Schema (slug)
- explode: true
- style: form
- - in: query
- name: local_context_schema__n
schema:
- type: array
- items:
- type: string
+ type: string
+ - name: local_context_schema__n
+ required: false
+ in: query
description: Schema (slug)
- explode: true
- style: form
- - in: query
- name: local_context_schema_id
schema:
- type: array
- items:
- type: string
- format: uuid
- nullable: true
+ type: string
+ - name: local_context_schema_id
+ required: false
+ in: query
description: Schema (ID)
- explode: true
- style: form
- - in: query
- name: local_context_schema_id__n
schema:
- type: array
- items:
- type: string
- format: uuid
- nullable: true
+ type: string
+ - name: local_context_schema_id__n
+ required: false
+ in: query
description: Schema (ID)
- explode: true
- style: form
- - in: query
- name: mac_address
schema:
- type: array
- items:
- type: string
- nullable: true
+ 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
- explode: true
- style: form
- - in: query
- name: mac_address__ic
schema:
- type: array
- items:
- type: string
- nullable: true
+ type: string
+ - name: mac_address__ic
+ required: false
+ in: query
description: MAC address
- explode: true
- style: form
- - in: query
- name: mac_address__ie
schema:
- type: array
- items:
- type: string
- nullable: true
+ type: string
+ - name: mac_address__ie
+ required: false
+ in: query
description: MAC address
- explode: true
- style: form
- - in: query
- name: mac_address__iew
schema:
- type: array
- items:
- type: string
- nullable: true
+ type: string
+ - name: mac_address__iew
+ required: false
+ in: query
description: MAC address
- explode: true
- style: form
- - in: query
- name: mac_address__ire
schema:
- type: array
- items:
- type: string
- nullable: true
+ type: string
+ - name: mac_address__ire
+ required: false
+ in: query
description: MAC address
- explode: true
- style: form
- - in: query
- name: mac_address__isw
schema:
- type: array
- items:
- type: string
- nullable: true
+ type: string
+ - name: mac_address__isw
+ required: false
+ in: query
description: MAC address
- explode: true
- style: form
- - in: query
- name: mac_address__n
schema:
- type: array
- items:
- type: string
- nullable: true
+ type: string
+ - name: mac_address__n
+ required: false
+ in: query
description: MAC address
- explode: true
- style: form
- - in: query
- name: mac_address__nic
schema:
- type: array
- items:
- type: string
- nullable: true
+ type: string
+ - name: mac_address__nic
+ required: false
+ in: query
description: MAC address
- explode: true
- style: form
- - in: query
- name: mac_address__nie
schema:
- type: array
- items:
- type: string
- nullable: true
+ type: string
+ - name: mac_address__nie
+ required: false
+ in: query
description: MAC address
- explode: true
- style: form
- - in: query
- name: mac_address__niew
schema:
- type: array
- items:
- type: string
- nullable: true
+ type: string
+ - name: mac_address__niew
+ required: false
+ in: query
description: MAC address
- explode: true
- style: form
- - in: query
- name: mac_address__nire
schema:
- type: array
- items:
- type: string
- nullable: true
+ type: string
+ - name: mac_address__nire
+ required: false
+ in: query
description: MAC address
- explode: true
- style: form
- - in: query
- name: mac_address__nisw
schema:
- type: array
- items:
- type: string
- nullable: true
+ type: string
+ - name: mac_address__nisw
+ required: false
+ in: query
description: MAC address
- explode: true
- style: form
- - in: query
- name: mac_address__nre
schema:
- type: array
- items:
- type: string
- nullable: true
+ type: string
+ - name: mac_address__nre
+ required: false
+ in: query
description: MAC address
- explode: true
- style: form
- - in: query
- name: mac_address__re
schema:
- type: array
- items:
- type: string
- nullable: true
+ type: string
+ - name: mac_address__re
+ required: false
+ in: query
description: MAC address
- explode: true
- style: form
- - in: query
- name: memory
schema:
- type: array
- items:
- type: integer
- explode: true
- style: form
- - in: query
- name: memory__gt
+ type: string
+ - name: memory
+ required: false
+ in: query
+ description: memory
schema:
- type: array
- items:
- type: integer
- explode: true
- style: form
- - in: query
- name: memory__gte
+ type: string
+ - name: memory__gt
+ required: false
+ in: query
+ description: memory__gt
schema:
- type: array
- items:
- type: integer
- explode: true
- style: form
- - in: query
- name: memory__lt
+ type: string
+ - name: memory__gte
+ required: false
+ in: query
+ description: memory__gte
schema:
- type: array
- items:
- type: integer
- explode: true
- style: form
- - in: query
- name: memory__lte
+ type: string
+ - name: memory__lt
+ required: false
+ in: query
+ description: memory__lt
schema:
- type: array
- items:
- type: integer
- explode: true
- style: form
- - in: query
- name: memory__n
+ type: string
+ - name: memory__lte
+ required: false
+ in: query
+ description: memory__lte
schema:
- type: array
- items:
- type: integer
- explode: true
- style: form
- - in: query
- name: name
+ type: string
+ - name: memory__n
+ required: false
+ in: query
+ description: memory__n
schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: name__ic
+ type: string
+ - name: name
+ required: false
+ in: query
+ description: name
schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: name__ie
+ type: string
+ - name: name__ic
+ required: false
+ in: query
+ description: name__ic
schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: name__iew
+ type: string
+ - name: name__ie
+ required: false
+ in: query
+ description: name__ie
schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: name__ire
+ type: string
+ - name: name__iew
+ required: false
+ in: query
+ description: name__iew
schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: name__isw
+ type: string
+ - name: name__ire
+ required: false
+ in: query
+ description: name__ire
schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: name__n
+ type: string
+ - name: name__isw
+ required: false
+ in: query
+ description: name__isw
schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: name__nic
+ type: string
+ - name: name__n
+ required: false
+ in: query
+ description: name__n
schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: name__nie
+ type: string
+ - name: name__nic
+ required: false
+ in: query
+ description: name__nic
schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: name__niew
+ type: string
+ - name: name__nie
+ required: false
+ in: query
+ description: name__nie
schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: name__nire
+ type: string
+ - name: name__niew
+ required: false
+ in: query
+ description: name__niew
schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: name__nisw
+ type: string
+ - name: name__nire
+ required: false
+ in: query
+ description: name__nire
schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: name__nre
+ type: string
+ - name: name__nisw
+ required: false
+ in: query
+ description: name__nisw
schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: name__re
+ type: string
+ - name: name__nre
+ required: false
+ in: query
+ description: name__nre
schema:
- type: array
- items:
- type: string
- explode: true
- style: form
+ 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
- - in: query
- name: platform
- schema:
- type: array
- items:
- type: string
+ - name: platform
+ required: false
+ in: query
description: Platform (slug)
- explode: true
- style: form
- - in: query
- name: platform__n
- schema:
- type: array
- items:
- type: string
- description: Platform (slug)
- explode: true
- style: form
- - in: query
- name: platform_id
- schema:
- type: array
- items:
- type: string
- format: uuid
- nullable: true
- description: Platform (ID)
- explode: true
- style: form
- - in: query
- name: platform_id__n
- schema:
- type: array
- items:
- type: string
- format: uuid
- nullable: true
- description: Platform (ID)
- explode: true
- style: form
- - in: query
- name: q
schema:
type: string
+ - 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
- - in: query
- name: region
schema:
- type: array
- items:
- type: string
- format: uuid
+ type: string
+ - name: region
+ required: false
+ in: query
description: Region (slug)
- explode: true
- style: form
- - in: query
- name: region__n
schema:
- type: array
- items:
- type: string
- format: uuid
+ type: string
+ - name: region__n
+ required: false
+ in: query
description: Region (slug)
- explode: true
- style: form
- - in: query
- name: region_id
schema:
- type: array
- items:
- type: string
- format: uuid
+ type: string
+ - name: region_id
+ required: false
+ in: query
description: Region (ID)
- explode: true
- style: form
- - in: query
- name: region_id__n
schema:
- type: array
- items:
- type: string
- format: uuid
+ type: string
+ - name: region_id__n
+ required: false
+ in: query
description: Region (ID)
- explode: true
- style: form
- - in: query
- name: role
schema:
- type: array
- items:
- type: string
+ type: string
+ - name: role
+ required: false
+ in: query
description: Role (slug)
- explode: true
- style: form
- - in: query
- name: role__n
schema:
- type: array
- items:
- type: string
+ type: string
+ - name: role__n
+ required: false
+ in: query
description: Role (slug)
- explode: true
- style: form
- - in: query
- name: role_id
schema:
- type: array
- items:
- type: string
- format: uuid
- nullable: true
+ type: string
+ - name: role_id
+ required: false
+ in: query
description: Role (ID)
- explode: true
- style: form
- - in: query
- name: role_id__n
schema:
- type: array
- items:
- type: string
- format: uuid
- nullable: true
+ type: string
+ - name: role_id__n
+ required: false
+ in: query
description: Role (ID)
- explode: true
- style: form
- - in: query
- name: site
schema:
- type: array
- items:
- type: string
+ 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)
- explode: true
- style: form
- - in: query
- name: site__n
schema:
- type: array
- items:
- type: string
+ type: string
+ - name: site__n
+ required: false
+ in: query
description: Site (slug)
- explode: true
- style: form
- - in: query
- name: site_id
schema:
- type: array
- items:
- type: string
- format: uuid
+ type: string
+ - name: site_id
+ required: false
+ in: query
description: Site (ID)
- explode: true
- style: form
- - in: query
- name: site_id__n
schema:
- type: array
- items:
- type: string
- format: uuid
+ type: string
+ - name: site_id__n
+ required: false
+ in: query
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
+ type: string
+ - name: status
+ required: false
+ in: query
+ description: status
schema:
- type: array
- items:
- type: string
- format: uuid
- explode: true
- style: form
- - in: query
- name: tag
+ type: string
+ - name: status__n
+ required: false
+ in: query
+ description: status__n
schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: tag__n
+ type: string
+ - name: tag
+ required: false
+ in: query
+ description: tag
schema:
- type: array
- items:
- type: string
- explode: true
- style: form
- - in: query
- name: tenant
+ type: string
+ - name: tag__n
+ required: false
+ in: query
+ description: tag__n
schema:
- type: array
- items:
- type: string
- description: Tenant (slug)
- explode: true
- style: form
- - in: query
- name: tenant__n
+ type: string
+ - name: tenant
+ required: false
+ in: query
+ description: Tenant (slug or ID)
schema:
- type: array
- items:
- type: string
- description: Tenant (slug)
- explode: true
- style: form
- - in: query
- name: tenant_group
+ type: string
+ - name: tenant__n
+ required: false
+ in: query
+ description: Tenant (slug or ID)
schema:
- type: array
- items:
- type: string
- format: uuid
+ type: string
+ - name: tenant_group
+ required: false
+ in: query
description: Tenant Group (slug)
- explode: true
- style: form
- - in: query
- name: tenant_group__n
schema:
- type: array
- items:
- type: string
- format: uuid
+ type: string
+ - name: tenant_group__n
+ required: false
+ in: query
description: Tenant Group (slug)
- explode: true
- style: form
- - in: query
- name: tenant_group_id
schema:
- type: array
- items:
- type: string
- format: uuid
+ type: string
+ - name: tenant_group_id
+ required: false
+ in: query
description: Tenant Group (ID)
- explode: true
- style: form
- - in: query
- name: tenant_group_id__n
schema:
- type: array
- items:
- type: string
- format: uuid
+ type: string
+ - name: tenant_group_id__n
+ required: false
+ in: query
description: Tenant Group (ID)
- explode: true
- style: form
- - in: query
- name: tenant_id
schema:
- type: array
- items:
- type: string
- format: uuid
- nullable: true
- description: Tenant (ID)
- explode: true
- style: form
- - in: query
- name: tenant_id__n
+ type: string
+ - name: tenant_id
+ required: false
+ in: query
+ description: Tenant (ID) (deprecated, use "tenant" filter instead)
schema:
- type: array
- items:
- type: string
- format: uuid
- nullable: true
- description: Tenant (ID)
- explode: true
- style: form
- - in: query
- name: vcpus
+ type: string
+ - name: tenant_id__n
+ required: false
+ in: query
+ description: Tenant (ID) (deprecated, use "tenant" filter instead)
schema:
- type: array
- items:
- type: integer
- explode: true
- style: form
- - in: query
- name: vcpus__gt
+ type: string
+ - name: vcpus
+ required: false
+ in: query
+ description: vcpus
schema:
- type: array
- items:
- type: integer
- explode: true
- style: form
- - in: query
- name: vcpus__gte
+ type: string
+ - name: vcpus__gt
+ required: false
+ in: query
+ description: vcpus__gt
schema:
- type: array
- items:
- type: integer
- explode: true
- style: form
- - in: query
- name: vcpus__lt
+ type: string
+ - name: vcpus__gte
+ required: false
+ in: query
+ description: vcpus__gte
schema:
- type: array
- items:
- type: integer
- explode: true
- style: form
- - in: query
- name: vcpus__lte
+ type: string
+ - name: vcpus__lt
+ required: false
+ in: query
+ description: vcpus__lt
schema:
- type: array
- items:
- type: integer
- explode: true
- style: form
- - in: query
- name: vcpus__n
+ type: string
+ - name: vcpus__lte
+ required: false
+ in: query
+ description: vcpus__lte
schema:
- type: array
- items:
- type: integer
- explode: true
- style: form
+ type: string
+ - name: vcpus__n
+ required: false
+ in: query
+ description: vcpus__n
+ schema:
+ type: string
tags:
- virtualization
security:
@@ -71437,13 +109659,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableVirtualMachineWithConfigContext'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableVirtualMachineWithConfigContext'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableVirtualMachineWithConfigContext'
+ $ref: '#/components/schemas/WritableVirtualMachineWithConfigContextRequest'
required: true
security:
- cookieAuth: []
@@ -71467,13 +109683,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableVirtualMachineWithConfigContext'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableVirtualMachineWithConfigContext'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableVirtualMachineWithConfigContext'
+ type: array
+ items:
+ $ref: '#/components/schemas/BulkWritableVirtualMachineWithConfigContextRequest'
required: true
security:
- cookieAuth: []
@@ -71483,7 +109695,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/VirtualMachineWithConfigContext'
+ type: array
+ items:
+ $ref: '#/components/schemas/VirtualMachineWithConfigContext'
description: ''
patch:
operationId: virtualization_virtual_machines_bulk_partial_update
@@ -71497,13 +109711,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableVirtualMachineWithConfigContext'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableVirtualMachineWithConfigContext'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableVirtualMachineWithConfigContext'
+ type: array
+ items:
+ $ref: '#/components/schemas/PatchedBulkWritableVirtualMachineWithConfigContextRequest'
+ required: true
security:
- cookieAuth: []
- tokenAuth: []
@@ -71512,7 +109723,9 @@ paths:
content:
application/json; version=1.3:
schema:
- $ref: '#/components/schemas/VirtualMachineWithConfigContext'
+ type: array
+ items:
+ $ref: '#/components/schemas/VirtualMachineWithConfigContext'
description: ''
delete:
operationId: virtualization_virtual_machines_bulk_destroy
@@ -71528,6 +109741,14 @@ paths:
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
@@ -71575,13 +109796,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/WritableVirtualMachineWithConfigContext'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/WritableVirtualMachineWithConfigContext'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/WritableVirtualMachineWithConfigContext'
+ $ref: '#/components/schemas/WritableVirtualMachineWithConfigContextRequest'
required: true
security:
- cookieAuth: []
@@ -71613,13 +109828,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/PatchedWritableVirtualMachineWithConfigContext'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/PatchedWritableVirtualMachineWithConfigContext'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/PatchedWritableVirtualMachineWithConfigContext'
+ $ref: '#/components/schemas/PatchedWritableVirtualMachineWithConfigContextRequest'
security:
- cookieAuth: []
- tokenAuth: []
@@ -71652,12 +109861,81 @@ paths:
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
@@ -71682,15 +109960,62 @@ components:
description: Corresponding ID value to grant access to.
Enter *
to grant access to all organizations, channels, or users
maxLength: 255
- display:
+ url:
type: string
+ format: uri
readOnly: true
- description: Human friendly display value
+ 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
@@ -71706,15 +110031,324 @@ components:
- SNMP
- SSH
type: string
- Aggregate:
+ ActionEnum:
+ enum:
+ - allow
+ - deny
+ - drop
+ - remark
+ type: string
+ AddressFamily:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an 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
@@ -71748,34 +110382,106 @@ components:
description:
type: string
maxLength: 200
- tags:
- type: array
- items:
- $ref: '#/components/schemas/TagSerializerField'
- custom_fields:
- type: object
- additionalProperties: {}
created:
type: string
format: date
readOnly: true
+ nullable: true
last_updated:
type: string
format: date-time
readOnly: true
- display:
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
type: string
+ format: uri
readOnly: true
- description: Human friendly display value
+ 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.
@@ -71812,9 +110518,21772 @@ components:
- 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
@@ -71829,6 +132298,10 @@ components:
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
@@ -71861,8 +132334,24 @@ components:
nullable: true
maxLength: 255
severity:
- type: string
- maxLength: 50
+ 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
@@ -71891,25 +132380,40 @@ components:
type: array
items:
$ref: '#/components/schemas/TagSerializerField'
- display:
+ created:
type: string
+ format: date
readOnly: true
- description: Human friendly display value
+ 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: Mixin to add `status` choice field to model serializers.
+ description: |-
+ Base class to use for serializers 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
@@ -71982,20 +132486,33 @@ components:
- 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: {}
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
+ - created
- display
- id
+ - last_updated
+ - notes_url
- status
- termination_a
- termination_a_id
@@ -72004,6 +132521,12 @@ components:
- termination_b_id
- termination_b_type
- url
+ CableStatusChoices:
+ type: string
+ enum:
+ - connected
+ - decommissioning
+ - planned
CableTypeChoices:
enum:
- cat3
@@ -72029,14 +132552,111 @@ components:
- aoc
- power
type: string
- Circuit:
+ CapircaPolicy:
type: object
- description: Mixin to add `status` choice field to model serializers.
+ 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
@@ -72098,31 +132718,34 @@ components:
readOnly: true
comments:
type: string
- tags:
- type: array
- items:
- $ref: '#/components/schemas/TagSerializerField'
- custom_fields:
- type: object
- additionalProperties: {}
created:
type: string
format: date
readOnly: true
+ nullable: true
last_updated:
type: string
format: date-time
readOnly: true
- display:
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
type: string
+ format: uri
readOnly: true
- description: Human friendly display value
+ custom_fields:
+ type: object
+ additionalProperties: {}
required:
- cid
- created
- display
- id
- last_updated
+ - notes_url
- provider
- status
- termination_a
@@ -72135,6 +132758,10 @@ components:
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
@@ -72145,6 +132772,10 @@ components:
readOnly: true
site:
$ref: '#/components/schemas/NestedSite'
+ location:
+ allOf:
+ - $ref: '#/components/schemas/NestedLocation'
+ nullable: true
provider_network:
$ref: '#/components/schemas/NestedProviderNetwork'
connected_endpoint:
@@ -72166,17 +132797,65 @@ components:
type: string
title: Cross-connect ID
maxLength: 50
- display:
+ 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
- description: Human friendly display value
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.
@@ -72200,7 +132879,7 @@ components:
status:
nullable: true
oneOf:
- - $ref: '#/components/schemas/CircuitMaintenanceStatusEnum'
+ - $ref: '#/components/schemas/StatusD95Enum'
- $ref: '#/components/schemas/BlankEnum'
- $ref: '#/components/schemas/NullEnum'
ack:
@@ -72234,26 +132913,78 @@ components:
- circuit
- id
- maintenance
- CircuitMaintenanceStatusEnum:
- enum:
- - TENTATIVE
- - CONFIRMED
- - CANCELLED
- - IN-PROCESS
- - COMPLETED
- - RE-SCHEDULED
- - UNKNOWN
+ 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: |-
- 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)
+ Base class to use for serializers 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
@@ -72268,6 +132999,10 @@ components:
allOf:
- $ref: '#/components/schemas/NestedSite'
nullable: true
+ location:
+ allOf:
+ - $ref: '#/components/schemas/NestedLocation'
+ nullable: true
provider_network:
allOf:
- $ref: '#/components/schemas/NestedProviderNetwork'
@@ -72322,10 +133057,23 @@ components:
type: boolean
nullable: true
readOnly: true
- display:
+ created:
type: string
+ format: date
readOnly: true
- description: Human friendly display value
+ 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
@@ -72334,19 +133082,28 @@ components:
- connected_endpoint
- connected_endpoint_reachable
- connected_endpoint_type
+ - created
- display
- id
+ - last_updated
+ - notes_url
- term_side
- url
CircuitType:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
@@ -72364,21 +133121,23 @@ components:
circuit_count:
type: integer
readOnly: true
- custom_fields:
- type: object
- additionalProperties: {}
created:
type: string
format: date
readOnly: true
+ nullable: true
last_updated:
type: string
format: date-time
readOnly: true
- display:
+ nullable: true
+ notes_url:
type: string
+ format: uri
readOnly: true
- description: Human friendly display value
+ custom_fields:
+ type: object
+ additionalProperties: {}
required:
- circuit_count
- created
@@ -72386,16 +133145,149 @@ components:
- 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: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
@@ -72417,33 +133309,39 @@ components:
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'
- custom_fields:
- type: object
- additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
device_count:
type: integer
readOnly: true
virtualmachine_count:
type: integer
readOnly: true
- display:
+ created:
type: string
+ format: date
readOnly: true
- description: Human friendly display value
+ 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
@@ -72451,18 +133349,25 @@ components:
- id
- last_updated
- name
+ - notes_url
- type
- url
- virtualmachine_count
ClusterGroup:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
@@ -72480,21 +133385,23 @@ components:
cluster_count:
type: integer
readOnly: true
- custom_fields:
- type: object
- additionalProperties: {}
created:
type: string
format: date
readOnly: true
+ nullable: true
last_updated:
type: string
format: date-time
readOnly: true
- display:
+ nullable: true
+ notes_url:
type: string
+ format: uri
readOnly: true
- description: Human friendly display value
+ custom_fields:
+ type: object
+ additionalProperties: {}
required:
- cluster_count
- created
@@ -72502,16 +133409,149 @@ components:
- 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: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
@@ -72529,21 +133569,23 @@ components:
cluster_count:
type: integer
readOnly: true
- custom_fields:
- type: object
- additionalProperties: {}
created:
type: string
format: date
readOnly: true
+ nullable: true
last_updated:
type: string
format: date-time
readOnly: true
- display:
+ nullable: true
+ notes_url:
type: string
+ format: uri
readOnly: true
- description: Human friendly display value
+ custom_fields:
+ type: object
+ additionalProperties: {}
required:
- cluster_count
- created
@@ -72551,11 +133593,142 @@ components:
- 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
@@ -72570,13 +133743,44 @@ components:
type: string
description: Token given by chat platform for signing or command validation
maxLength: 255
- display:
+ url:
type: string
+ format: uri
readOnly: true
- description: Human friendly display value
+ 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:
@@ -72587,18 +133791,14 @@ components:
type: string
format: uuid
readOnly: true
- tags:
- type: array
- items:
- $ref: '#/components/schemas/TagSerializerField'
display:
type: string
readOnly: true
description: Human friendly display value
- computed_fields:
- type: object
- additionalProperties: {}
- readOnly: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
custom_fields:
type: object
additionalProperties: {}
@@ -72610,10 +133810,12 @@ components:
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: {}
@@ -72629,7 +133831,6 @@ components:
type: string
maxLength: 200
required:
- - computed_fields
- created
- display
- id
@@ -72637,6 +133838,36 @@ components:
- 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.
@@ -72645,18 +133876,14 @@ components:
type: string
format: uuid
readOnly: true
- tags:
- type: array
- items:
- $ref: '#/components/schemas/TagSerializerField'
display:
type: string
readOnly: true
description: Human friendly display value
- computed_fields:
- type: object
- additionalProperties: {}
- readOnly: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
custom_fields:
type: object
additionalProperties: {}
@@ -72668,10 +133895,12 @@ components:
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: {}
@@ -72701,7 +133930,6 @@ components:
type: string
format: uuid
required:
- - computed_fields
- config_ordered
- created
- display
@@ -72710,6 +133938,49 @@ components:
- 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: |-
@@ -72720,13 +133991,18 @@ components:
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
+ description: Internal field name. Please use underscores rather than dashes
+ in this slug.
maxLength: 100
pattern: ^[-a-zA-Z0-9_]+$
label:
@@ -72751,17 +134027,70 @@ components:
type: integer
maximum: 32767
minimum: 0
- display:
+ 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
- description: Human friendly display value
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.
@@ -72770,18 +134099,14 @@ components:
type: string
format: uuid
readOnly: true
- tags:
- type: array
- items:
- $ref: '#/components/schemas/TagSerializerField'
display:
type: string
readOnly: true
description: Human friendly display value
- computed_fields:
- type: object
- additionalProperties: {}
- readOnly: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
custom_fields:
type: object
additionalProperties: {}
@@ -72789,10 +134114,12 @@ components:
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: {}
@@ -72831,13 +134158,63 @@ components:
type: string
format: uuid
required:
- - computed_fields
- 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: |-
@@ -72848,6 +134225,10 @@ components:
type: string
format: uuid
readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
url:
type: string
format: uri
@@ -72885,6 +134266,10 @@ components:
items:
type: object
properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
id:
type: string
format: uuid
@@ -72907,10 +134292,6 @@ components:
type: integer
readOnly: true
title: ' depth'
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- _depth
- display
@@ -72923,6 +134304,10 @@ components:
items:
type: object
properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
id:
type: string
format: uuid
@@ -72938,20 +134323,54 @@ components:
type: string
maxLength: 100
pattern: ^[-a-zA-Z0-9_]+$
- display:
- type: string
- readOnly: true
- description: Human friendly display value
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
@@ -72973,10 +134392,6 @@ components:
virtualmachine_count:
type: integer
readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- device_count
- display
@@ -72989,6 +134404,10 @@ components:
items:
type: object
properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
id:
type: string
format: uuid
@@ -73011,10 +134430,6 @@ components:
device_count:
type: integer
readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- device_count
- display
@@ -73028,6 +134443,10 @@ components:
items:
type: object
properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
id:
type: string
format: uuid
@@ -73049,10 +134468,6 @@ components:
virtualmachine_count:
type: integer
readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- device_count
- display
@@ -73065,6 +134480,10 @@ components:
items:
type: object
properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
id:
type: string
format: uuid
@@ -73083,10 +134502,6 @@ components:
cluster_count:
type: integer
readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- cluster_count
- display
@@ -73098,6 +134513,10 @@ components:
items:
type: object
properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
id:
type: string
format: uuid
@@ -73112,10 +134531,6 @@ components:
virtualmachine_count:
type: integer
readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- display
- id
@@ -73127,6 +134542,10 @@ components:
items:
type: object
properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
id:
type: string
format: uuid
@@ -73149,10 +134568,6 @@ components:
type: integer
readOnly: true
title: ' depth'
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- _depth
- display
@@ -73165,6 +134580,10 @@ components:
items:
type: object
properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
id:
type: string
format: uuid
@@ -73180,10 +134599,6 @@ components:
type: string
maxLength: 100
pattern: ^[-a-zA-Z0-9_]+$
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- display
- id
@@ -73200,14 +134615,16 @@ components:
type: string
format: date
readOnly: true
+ nullable: true
last_updated:
type: string
format: date-time
readOnly: true
- display:
+ nullable: true
+ notes_url:
type: string
+ format: uri
readOnly: true
- description: Human friendly display value
required:
- created
- data
@@ -73215,18 +134632,24 @@ components:
- id
- last_updated
- name
+ - notes_url
- owner
- url
ConfigContextSchema:
type: object
description: |-
- Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
- validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)
+ Base class to use for serializers 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
@@ -73262,14 +134685,19 @@ components:
type: string
format: date
readOnly: true
+ nullable: true
last_updated:
type: string
format: date-time
readOnly: true
- display:
+ nullable: true
+ notes_url:
type: string
+ format: uri
readOnly: true
- description: Human friendly display value
+ custom_fields:
+ type: object
+ additionalProperties: {}
required:
- created
- data_schema
@@ -73277,8 +134705,148 @@ components:
- 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.
@@ -73287,18 +134855,14 @@ components:
type: string
format: uuid
readOnly: true
- tags:
- type: array
- items:
- $ref: '#/components/schemas/TagSerializerField'
display:
type: string
readOnly: true
description: Human friendly display value
- computed_fields:
- type: object
- additionalProperties: {}
- readOnly: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
custom_fields:
type: object
additionalProperties: {}
@@ -73310,10 +134874,12 @@ components:
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: {}
@@ -73333,7 +134899,6 @@ components:
type: string
format: uuid
required:
- - computed_fields
- created
- display
- id
@@ -73342,6 +134907,41 @@ components:
- 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.
@@ -73350,18 +134950,14 @@ components:
type: string
format: uuid
readOnly: true
- tags:
- type: array
- items:
- $ref: '#/components/schemas/TagSerializerField'
display:
type: string
readOnly: true
description: Human friendly display value
- computed_fields:
- type: object
- additionalProperties: {}
- readOnly: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
custom_fields:
type: object
additionalProperties: {}
@@ -73373,10 +134969,12 @@ components:
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: {}
@@ -73402,7 +135000,6 @@ components:
type: string
format: uuid
required:
- - computed_fields
- created
- display
- id
@@ -73412,6 +135009,239 @@ components:
- 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
@@ -73420,13 +135250,19 @@ components:
type: string
ConsolePort:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
@@ -73504,43 +135340,57 @@ components:
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: {}
- computed_fields:
- type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- cable
- cable_peer
- cable_peer_type
- - computed_fields
- connected_endpoint
- connected_endpoint_reachable
- connected_endpoint_type
+ - created
- device
- display
- id
+ - last_updated
- name
+ - notes_url
- url
ConsolePortTemplate:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
@@ -73592,20 +135442,29 @@ components:
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: {}
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
+ - created
- device_type
- display
- id
+ - last_updated
- name
- url
ConsolePortTypeChoices:
+ type: string
enum:
- de-9
- db-25
@@ -73620,16 +135479,21 @@ components:
- usb-micro-a
- usb-micro-b
- other
- type: string
ConsoleServerPort:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
@@ -73707,17 +135571,27 @@ components:
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: {}
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- cable
- cable_peer
@@ -73725,20 +135599,29 @@ components:
- connected_endpoint
- connected_endpoint_reachable
- connected_endpoint_type
+ - created
- device
- display
- id
+ - last_updated
- name
+ - notes_url
- url
ConsoleServerPortTemplate:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
@@ -73790,23 +135673,43 @@ components:
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: {}
- display:
- type: string
- readOnly: true
- description: Human friendly display value
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
@@ -73839,20 +135742,41 @@ components:
type: array
items:
$ref: '#/components/schemas/TagSerializerField'
- display:
+ created:
type: string
+ format: date
readOnly: true
- description: Human friendly display value
+ 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
@@ -73864,9 +135788,6 @@ components:
type: string
title: Python model class name
maxLength: 100
- display:
- type: string
- readOnly: true
required:
- app_label
- display
@@ -73877,6 +135798,14 @@ components:
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
@@ -73922,17 +135851,26 @@ components:
type: array
items:
$ref: '#/components/schemas/TagSerializerField'
- display:
+ created:
type: string
+ format: date
readOnly: true
- description: Human friendly display value
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
required:
+ - created
- display
- expired
- id
+ - last_updated
- name
- provider
- CustomField:
+ - url
+ CustomFieldChoice:
type: object
description: |-
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
@@ -73942,6 +135880,56 @@ components:
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
@@ -73975,15 +135963,15 @@ components:
- Selection
- Multiple selection
- JSON
- name:
- type: string
- title: Slug
- description: URL-friendly unique shorthand.
- maxLength: 50
label:
type: string
- description: Name of the field as displayed to users (if not provided, the
- field's slug will be used.)
+ maxLength: 50
+ name:
+ type: string
+ description: Human-readable unique name of this field.
+ maxLength: 50
+ slug:
+ type: string
maxLength: 50
description:
type: string
@@ -74043,52 +136031,104 @@ components:
on select and multi-select will be applied at Custom Field Choices
definition.
maxLength: 500
- display:
+ 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
- description: Human friendly display value
required:
- content_types
+ - created
- display
- id
+ - last_updated
- name
+ - notes_url
- type
- url
- CustomFieldChoice:
+ 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:
- id:
+ content_types:
+ type: array
+ items:
+ type: string
+ type:
+ $ref: '#/components/schemas/CustomFieldTypeChoices'
+ label:
type: string
- format: uuid
- readOnly: true
- url:
+ minLength: 1
+ maxLength: 50
+ name:
type: string
- format: uri
- readOnly: true
- field:
- $ref: '#/components/schemas/NestedCustomField'
- value:
+ minLength: 1
+ description: Human-readable unique name of this field.
+ maxLength: 50
+ slug:
type: string
- maxLength: 100
+ 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: Higher weights appear later in the list
- display:
+ 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
- readOnly: true
- description: Human friendly display value
+ 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:
- - display
- - field
- id
- - url
- - value
CustomFieldTypeChoices:
+ type: string
enum:
- text
- integer
@@ -74098,7 +136138,6 @@ components:
- select
- multi-select
- json
- type: string
CustomLink:
type: object
description: |-
@@ -74109,6 +136148,10 @@ components:
type: string
format: uuid
readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
url:
type: string
format: uri
@@ -74146,27 +136189,95 @@ components:
new_window:
type: boolean
description: Force link to open in a new window
- display:
+ 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
- description: Human friendly display value
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
- - url
Device:
type: object
- description: Mixin to add `status` choice field to model serializers.
+ description: |-
+ Base class to use for serializers 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
@@ -74198,6 +136309,10 @@ components:
maxLength: 50
site:
$ref: '#/components/schemas/NestedSite'
+ location:
+ allOf:
+ - $ref: '#/components/schemas/NestedLocation'
+ nullable: true
rack:
allOf:
- $ref: '#/components/schemas/NestedRack'
@@ -74283,6 +136398,16 @@ components:
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:
@@ -74293,37 +136418,35 @@ components:
type: object
additionalProperties: {}
nullable: true
- tags:
- type: array
- items:
- $ref: '#/components/schemas/TagSerializerField'
- custom_fields:
- type: object
- additionalProperties: {}
created:
type: string
format: date
readOnly: true
+ nullable: true
last_updated:
type: string
format: date-time
readOnly: true
- computed_fields:
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
+ type: string
+ format: uri
+ readOnly: true
+ custom_fields:
type: object
additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- - computed_fields
- created
- device_role
- device_type
- display
- id
- last_updated
+ - notes_url
- parent_device
- primary_ip
- site
@@ -74331,13 +136454,19 @@ components:
- url
DeviceBay:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
@@ -74358,32 +136487,51 @@ components:
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: {}
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
+ - created
- device
- display
- id
+ - last_updated
- name
+ - notes_url
- url
DeviceBayTemplate:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
@@ -74400,17 +136548,25 @@ components:
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: {}
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
+ - created
- device_type
- display
- id
+ - last_updated
- name
- url
DeviceNAPALM:
@@ -74421,15 +136577,119 @@ components:
additionalProperties: {}
required:
- method
- DeviceRole:
+ DeviceRedundancyGroup:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
@@ -74457,21 +136717,23 @@ components:
virtualmachine_count:
type: integer
readOnly: true
- custom_fields:
- type: object
- additionalProperties: {}
created:
type: string
format: date
readOnly: true
+ nullable: true
last_updated:
type: string
format: date-time
readOnly: true
- display:
+ nullable: true
+ notes_url:
type: string
+ format: uri
readOnly: true
- description: Human friendly display value
+ custom_fields:
+ type: object
+ additionalProperties: {}
required:
- created
- device_count
@@ -74479,17 +136741,168 @@ components:
- 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: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
@@ -74536,28 +136949,30 @@ components:
format: uri
comments:
type: string
- tags:
- type: array
- items:
- $ref: '#/components/schemas/TagSerializerField'
- custom_fields:
- type: object
- additionalProperties: {}
+ device_count:
+ type: integer
+ readOnly: true
created:
type: string
format: date
readOnly: true
+ nullable: true
last_updated:
type: string
format: date-time
readOnly: true
- device_count:
- type: integer
- readOnly: true
- display:
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
type: string
+ format: uri
readOnly: true
- description: Human friendly display value
+ custom_fields:
+ type: object
+ additionalProperties: {}
required:
- created
- device_count
@@ -74566,15 +136981,23 @@ components:
- last_updated
- manufacturer
- model
+ - notes_url
- url
DeviceWithConfigContext:
type: object
- description: Mixin to add `status` choice field to model serializers.
+ description: |-
+ Base class to use for serializers 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
@@ -74606,6 +137029,10 @@ components:
maxLength: 50
site:
$ref: '#/components/schemas/NestedSite'
+ location:
+ allOf:
+ - $ref: '#/components/schemas/NestedLocation'
+ nullable: true
rack:
allOf:
- $ref: '#/components/schemas/NestedRack'
@@ -74691,6 +137118,16 @@ components:
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:
@@ -74701,13 +137138,6 @@ components:
type: object
additionalProperties: {}
nullable: true
- tags:
- type: array
- items:
- $ref: '#/components/schemas/TagSerializerField'
- custom_fields:
- type: object
- additionalProperties: {}
config_context:
type: object
additionalProperties: {}
@@ -74716,14 +137146,23 @@ components:
type: string
format: date
readOnly: true
+ nullable: true
last_updated:
type: string
format: date-time
readOnly: true
- display:
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
type: string
+ format: uri
readOnly: true
- description: Human friendly display value
+ custom_fields:
+ type: object
+ additionalProperties: {}
required:
- config_context
- created
@@ -74732,6 +137171,7 @@ components:
- display
- id
- last_updated
+ - notes_url
- parent_device
- primary_ip
- site
@@ -74740,13 +137180,18 @@ components:
DynamicGroup:
type: object
description: |-
- Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
- validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)
+ Base class to use for serializers 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
@@ -74769,18 +137214,40 @@ components:
type: object
additionalProperties: {}
description: A JSON-encoded dictionary of filter parameters for group membership
- display:
- type: string
+ children:
+ type: array
+ items:
+ $ref: '#/components/schemas/NestedDynamicGroupMembership'
readOnly: true
- description: Human friendly display value
+ 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
- ExportTemplate:
+ DynamicGroupMembership:
type: object
description: |-
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
@@ -74790,6 +137257,180 @@ components:
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
@@ -74826,49 +137467,307 @@ components:
type: string
description: Extension to append to the rendered filename
maxLength: 15
- display:
+ 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
- description: Human friendly display value
required:
- content_type
+ - created
- display
- id
+ - last_updated
- name
+ - notes_url
- owner
- template_code
- url
- FaceEnum:
- enum:
- - front
- - rear
- type: string
- FamilyEnum:
- type: integer
- enum:
- - 4
- - 6
- FeedLegEnum:
- enum:
- - A
- - B
- - C
- type: string
- FilterLogicEnum:
- enum:
- - disabled
- - loose
- - exact
- type: string
- FrontPort:
+ ExportTemplateRequest:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an 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
@@ -74968,25 +137867,38 @@ components:
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: {}
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- cable
- cable_peer
- cable_peer_type
+ - created
- device
- display
- id
+ - last_updated
- name
+ - notes_url
- rear_port
- type
- url
@@ -74995,6 +137907,10 @@ components:
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
@@ -75010,24 +137926,53 @@ components:
type: string
description: Physical label
maxLength: 64
- display:
+ created:
type: string
+ format: date
readOnly: true
- description: Human friendly display value
+ 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: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
@@ -75114,17 +138059,25 @@ components:
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: {}
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
+ - created
- device_type
- display
- id
+ - last_updated
- name
- rear_port
- type
@@ -75137,6 +138090,10 @@ components:
type: string
format: uuid
readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
url:
type: string
format: uri
@@ -75156,9 +138113,6 @@ components:
branch:
type: string
maxLength: 64
- token:
- type: string
- writeOnly: true
username:
type: string
maxLength: 64
@@ -75181,25 +138135,181 @@ components:
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: {}
- display:
- type: string
- readOnly: true
- description: Human friendly display value
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.
@@ -75208,18 +138318,14 @@ components:
type: string
format: uuid
readOnly: true
- tags:
- type: array
- items:
- $ref: '#/components/schemas/TagSerializerField'
display:
type: string
readOnly: true
description: Human friendly display value
- computed_fields:
- type: object
- additionalProperties: {}
- readOnly: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
custom_fields:
type: object
additionalProperties: {}
@@ -75231,10 +138337,12 @@ components:
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: {}
@@ -75277,13 +138385,66 @@ components:
format: uuid
description: device
required:
- - computed_fields
- 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.
@@ -75292,18 +138453,14 @@ components:
type: string
format: uuid
readOnly: true
- tags:
- type: array
- items:
- $ref: '#/components/schemas/TagSerializerField'
display:
type: string
readOnly: true
description: Human friendly display value
- computed_fields:
- type: object
- additionalProperties: {}
- readOnly: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
custom_fields:
type: object
additionalProperties: {}
@@ -75311,14 +138468,21 @@ components:
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: {}
@@ -75361,12 +138525,6 @@ components:
title: Backup Test
description: Whether or not to pretest the connectivity of the device by
verifying there is a resolvable IP that can connect to port 22.
- scope:
- type: object
- additionalProperties: {}
- nullable: true
- description: API filter in JSON format matching the list of devices for
- the scope of devices to be considered.
backup_repository:
type: string
format: uuid
@@ -75384,7 +138542,6 @@ components:
format: uuid
nullable: true
required:
- - computed_fields
- created
- display
- id
@@ -75398,11 +138555,12 @@ components:
- channel
- user
type: string
- GraphQLAPI:
+ GraphQLAPIRequest:
type: object
properties:
query:
type: string
+ minLength: 1
description: GraphQL query
variables:
type: object
@@ -75420,6 +138578,10 @@ components:
type: string
format: uuid
readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
url:
type: string
format: uri
@@ -75438,17 +138600,30 @@ components:
additionalProperties: {}
nullable: true
default: {}
- display:
+ 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
- description: Human friendly display value
required:
+ - created
- display
- id
+ - last_updated
- name
+ - notes_url
- query
- url
- GraphQLQueryInput:
+ GraphQLQueryInputRequest:
type: object
properties:
variables:
@@ -75463,12 +138638,41 @@ components:
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
@@ -75482,20 +138686,36 @@ components:
user_count:
type: integer
readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
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
@@ -75550,16 +138770,25 @@ components:
type: array
items:
$ref: '#/components/schemas/TagSerializerField'
- display:
+ created:
type: string
+ format: date
readOnly: true
- description: Human friendly display value
+ 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
@@ -75570,12 +138799,19 @@ components:
type: string
IPAddress:
type: object
- description: Mixin to add `status` choice field to model serializers.
+ description: |-
+ Base class to use for serializers 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
@@ -75677,25 +138913,27 @@ components:
description:
type: string
maxLength: 200
- tags:
- type: array
- items:
- $ref: '#/components/schemas/TagSerializerField'
- custom_fields:
- type: object
- additionalProperties: {}
created:
type: string
format: date
readOnly: true
+ nullable: true
last_updated:
type: string
format: date-time
readOnly: true
- display:
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
type: string
+ format: uri
readOnly: true
- description: Human friendly display value
+ custom_fields:
+ type: object
+ additionalProperties: {}
required:
- address
- assigned_object
@@ -75705,8 +138943,233 @@ components:
- 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: |-
@@ -75717,6 +139180,10 @@ components:
type: string
format: uuid
readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
url:
type: string
format: uri
@@ -75748,10 +139215,6 @@ components:
type: string
format: date-time
readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- content_type
- created
@@ -75763,6 +139226,37 @@ components:
- 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
@@ -75772,13 +139266,19 @@ components:
type: string
Interface:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
@@ -75792,6 +139292,25 @@ components:
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:
@@ -75799,6 +139318,7 @@ components:
type: string
enum:
- virtual
+ - bridge
- lag
- 100base-tx
- 1000base-t
@@ -75875,6 +139395,7 @@ components:
type: string
enum:
- Virtual
+ - Bridge
- Link Aggregation Group (LAG)
- 100BASE-TX (10/100ME)
- 1000BASE-T (1GE)
@@ -75949,6 +139470,14 @@ components:
- 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'
@@ -75993,6 +139522,10 @@ components:
items:
type: object
properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
id:
type: string
format: uuid
@@ -76009,10 +139542,6 @@ components:
name:
type: string
maxLength: 64
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- display
- id
@@ -76045,20 +139574,30 @@ components:
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'
- count_ipaddresses:
- type: integer
+ notes_url:
+ type: string
+ format: uri
readOnly: true
custom_fields:
type: object
additionalProperties: {}
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- cable
- cable_peer
@@ -76067,10 +139606,14 @@ components:
- connected_endpoint_reachable
- connected_endpoint_type
- count_ipaddresses
+ - created
- device
- display
- id
+ - last_updated
- name
+ - notes_url
+ - status
- type
- url
InterfaceConnection:
@@ -76079,6 +139622,14 @@ components:
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'
@@ -76089,30 +139640,45 @@ components:
type: boolean
nullable: true
readOnly: true
- display:
+ created:
type: string
+ format: date
readOnly: true
- description: Human friendly display value
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
required:
- connected_endpoint_reachable
+ - created
- display
+ - id
- interface_a
- interface_b
- InterfaceTemplate:
+ - last_updated
+ InterfaceSerializerVersion12:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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'
+ device:
+ $ref: '#/components/schemas/NestedDevice'
name:
type: string
maxLength: 64
@@ -76127,6 +139693,7 @@ components:
type: string
enum:
- virtual
+ - bridge
- lag
- 100base-tx
- 1000base-t
@@ -76203,6 +139770,347 @@ components:
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)
@@ -76281,23 +140189,33 @@ components:
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: {}
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
+ - created
- device_type
- display
- id
+ - last_updated
- name
- type
- url
InterfaceTypeChoices:
+ type: string
enum:
- virtual
+ - bridge
- lag
- 100base-tx
- 1000base-t
@@ -76370,24 +140288,21 @@ components:
- extreme-summitstack-256
- extreme-summitstack-512
- other
- type: string
- IntervalEnum:
- enum:
- - immediately
- - future
- - hourly
- - daily
- - weekly
- type: string
InventoryItem:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
@@ -76428,37 +140343,181 @@ components:
description:
type: string
maxLength: 200
- tags:
- type: array
- items:
- $ref: '#/components/schemas/TagSerializerField'
_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: {}
- display:
- type: string
- readOnly: true
- description: Human friendly display value
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: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
@@ -76511,6 +140570,17 @@ components:
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
@@ -76562,35 +140632,48 @@ components:
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'
- custom_fields:
- type: object
- additionalProperties: {}
created:
type: string
format: date
readOnly: true
+ nullable: true
last_updated:
type: string
format: date-time
readOnly: true
- display:
+ nullable: true
+ notes_url:
type: string
+ format: uri
readOnly: true
- description: Human friendly display value
+ 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:
@@ -76635,24 +140718,253 @@ components:
- test_methods
- url
- vars
- JobInput:
+ 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: {}
- default: ''
commit:
type: boolean
schedule:
- $ref: '#/components/schemas/NestedScheduledJob'
+ $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
@@ -76679,16 +140991,269 @@ components:
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
@@ -76742,12 +141307,20 @@ components:
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
@@ -76757,14 +141330,6 @@ components:
- status
- url
- user
- JobResultStatusEnum:
- type: string
- enum:
- - pending
- - running
- - completed
- - errored
- - failed
JobRunResponse:
type: object
description: Serializer representing responses from the JobModelViewSet.run()
@@ -76838,12 +141403,189 @@ components:
- 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
@@ -76854,13 +141596,19 @@ components:
type: string
Manufacturer:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
@@ -76884,21 +141632,23 @@ components:
platform_count:
type: integer
readOnly: true
- custom_fields:
- type: object
- additionalProperties: {}
created:
type: string
format: date
readOnly: true
+ nullable: true
last_updated:
type: string
format: date-time
readOnly: true
- display:
+ nullable: true
+ notes_url:
type: string
+ format: uri
readOnly: true
- description: Human friendly display value
+ custom_fields:
+ type: object
+ additionalProperties: {}
required:
- created
- devicetype_count
@@ -76907,12 +141657,143 @@ components:
- 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
@@ -76956,14 +141837,12 @@ components:
type: string
format: date
readOnly: true
+ nullable: true
last_updated:
type: string
format: date-time
readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
+ nullable: true
required:
- content_type
- created
@@ -76974,12 +141853,3316 @@ components:
- 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
- type: string
+ 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.
@@ -77015,8 +145198,7 @@ components:
nullable: true
maxLength: 255
severity:
- type: string
- maxLength: 50
+ $ref: '#/components/schemas/SeverityEnum'
cvss:
type: number
format: double
@@ -77045,12 +145227,70 @@ components:
- 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.
+
+ 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
@@ -77062,20 +145302,36 @@ components:
label:
type: string
maxLength: 100
- display:
- type: string
- readOnly: true
- description: Human friendly display value
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
@@ -77088,21 +145344,34 @@ components:
type: string
title: Circuit ID
maxLength: 100
- display:
- type: string
- readOnly: true
- description: Human friendly display value
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
@@ -77121,22 +145390,38 @@ components:
circuit_count:
type: integer
readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
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
@@ -77151,10 +145436,6 @@ components:
virtualmachine_count:
type: integer
readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- display
- id
@@ -77167,6 +145448,10 @@ components:
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
@@ -77185,22 +145470,50 @@ components:
cluster_count:
type: integer
readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
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
@@ -77219,22 +145532,38 @@ components:
cluster_count:
type: integer
readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
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
@@ -77250,19 +145579,35 @@ components:
type: string
maxLength: 200
pattern: ^[-a-zA-Z0-9_]+$
- display:
- type: string
- readOnly: true
- description: Human friendly display value
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
@@ -77301,22 +145646,60 @@ components:
expired:
type: string
readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
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
@@ -77327,24 +145710,36 @@ components:
readOnly: true
name:
type: string
- title: Slug
- description: URL-friendly unique shorthand.
+ description: Human-readable unique name of this field.
maxLength: 50
- display:
- type: string
- readOnly: true
- description: Human friendly display value
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
@@ -77357,20 +145752,86 @@ components:
type: string
nullable: true
maxLength: 64
- display:
- type: string
- readOnly: true
- description: Human friendly display value
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
@@ -77392,10 +145853,6 @@ components:
virtualmachine_count:
type: integer
readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- device_count
- display
@@ -77403,12 +145860,32 @@ components:
- 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
@@ -77431,10 +145908,6 @@ components:
device_count:
type: integer
readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- device_count
- display
@@ -77443,12 +145916,177 @@ components:
- 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
@@ -77462,22 +146100,71 @@ components:
readOnly: true
address:
type: string
- display:
- type: string
- readOnly: true
- description: Human friendly display value
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
@@ -77497,22 +146184,38 @@ components:
type: string
format: uuid
nullable: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
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
@@ -77532,10 +146235,6 @@ components:
type: integer
readOnly: true
title: ' depth'
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- _depth
- device
@@ -77543,9 +146242,33 @@ components:
- 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
@@ -77580,6 +146303,7 @@ components:
maxLength: 320
pattern: ^[-a-zA-Z0-9_]+$
required:
+ - display
- grouping
- id
- job_class_name
@@ -77589,7 +146313,19 @@ components:
- 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
@@ -77634,17 +146370,124 @@ components:
- 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
@@ -77663,22 +146506,184 @@ components:
devicetype_count:
type: integer
readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
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
@@ -77700,10 +146705,6 @@ components:
virtualmachine_count:
type: integer
readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- device_count
- display
@@ -77711,12 +146712,32 @@ components:
- 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
@@ -77731,22 +146752,34 @@ components:
powerfeed_count:
type: integer
readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
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
@@ -77766,22 +146799,38 @@ components:
type: string
format: uuid
nullable: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
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
@@ -77793,21 +146842,73 @@ components:
name:
type: string
maxLength: 64
- display:
- type: string
- readOnly: true
- description: Human friendly display value
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
@@ -77826,10 +146927,6 @@ components:
circuit_count:
type: integer
readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- circuit_count
- display
@@ -77840,6 +146937,10 @@ components:
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
@@ -77863,20 +146964,46 @@ components:
maxLength: 254
comments:
type: string
- display:
- type: string
- readOnly: true
- description: Human friendly display value
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
@@ -77892,21 +147019,53 @@ components:
type: string
maxLength: 100
pattern: ^[-a-zA-Z0-9_]+$
- display:
- type: string
- readOnly: true
- description: Human friendly display value
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
@@ -77925,22 +147084,38 @@ components:
aggregate_count:
type: integer
readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
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
@@ -77955,10 +147130,6 @@ components:
device_count:
type: integer
readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- device_count
- display
@@ -77971,6 +147142,10 @@ components:
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
@@ -77993,10 +147168,6 @@ components:
type: integer
readOnly: true
title: ' depth'
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- _depth
- display
@@ -78004,12 +147175,44 @@ components:
- 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
@@ -78028,22 +147231,38 @@ components:
rack_count:
type: integer
readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
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
@@ -78055,21 +147274,33 @@ components:
name:
type: string
maxLength: 64
- display:
- type: string
- readOnly: true
- description: Human friendly display value
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
@@ -78092,10 +147323,6 @@ components:
type: integer
readOnly: true
title: ' depth'
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- _depth
- display
@@ -78103,12 +147330,32 @@ components:
- 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
@@ -78119,27 +147366,48 @@ components:
readOnly: true
name:
type: string
- description: Internal relationship name
+ 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_]+$
- display:
- type: string
- readOnly: true
- description: Human friendly display value
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
@@ -78161,10 +147429,6 @@ components:
vlan_count:
type: integer
readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- display
- id
@@ -78172,9 +147436,65 @@ components:
- 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
@@ -78182,7 +147502,42 @@ components:
type: string
format: date-time
interval:
- $ref: '#/components/schemas/IntervalEnum'
+ $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:
@@ -78191,6 +147546,10 @@ components:
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
@@ -78206,21 +147565,37 @@ components:
type: string
maxLength: 100
pattern: ^[-a-zA-Z0-9_]+$
- display:
- type: string
- readOnly: true
- description: Human friendly display value
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
@@ -78236,10 +147611,6 @@ components:
type: string
maxLength: 100
pattern: ^[-a-zA-Z0-9_]+$
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- display
- id
@@ -78251,6 +147622,10 @@ components:
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
@@ -78265,10 +147640,6 @@ components:
$ref: '#/components/schemas/SecretTypeEnum'
secret:
$ref: '#/components/schemas/NestedSecret'
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- access_type
- display
@@ -78276,12 +147647,46 @@ components:
- 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
@@ -78297,19 +147702,35 @@ components:
type: string
maxLength: 100
pattern: ^[-a-zA-Z0-9_]+$
- display:
- type: string
- readOnly: true
- description: Human friendly display value
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
@@ -78330,22 +147751,37 @@ components:
format: date
nullable: true
title: End of Software Support
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- device_platform
- display
- id
- url
- version
+ 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
@@ -78361,10 +147797,6 @@ components:
type: string
maxLength: 100
pattern: ^[-a-zA-Z0-9_]+$
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- display
- id
@@ -78376,6 +147808,10 @@ components:
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
@@ -78398,10 +147834,6 @@ components:
type: integer
readOnly: true
title: ' depth'
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- _depth
- display
@@ -78409,12 +147841,48 @@ components:
- 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
@@ -78429,21 +147897,36 @@ components:
only.
pattern: ^[\w.@+-]+$
maxLength: 150
- display:
- type: string
- readOnly: true
- description: Human friendly display value
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
@@ -78460,10 +147943,6 @@ components:
name:
type: string
maxLength: 64
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- display
- id
@@ -78476,6 +147955,10 @@ components:
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
@@ -78494,16 +147977,88 @@ components:
vlan_count:
type: integer
readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
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: |-
@@ -78540,12 +148095,34 @@ components:
- 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
@@ -78562,10 +148139,6 @@ components:
member_count:
type: integer
readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- display
- id
@@ -78573,12 +148146,30 @@ components:
- 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
@@ -78590,35 +148181,126 @@ components:
name:
type: string
maxLength: 64
- display:
- type: string
- readOnly: true
- description: Human friendly display value
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: Serializer for API.
+ 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
- maintenance:
+ 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
- title:
+ assigned_object:
+ type: object
+ additionalProperties: {}
+ nullable: true
+ readOnly: true
+ note:
type: string
- maxLength: 200
- comment:
+ 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:
- - comment
+ - assigned_object
+ - assigned_object_id
+ - assigned_object_type
+ - created
+ - display
- id
- - title
+ - 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.
@@ -78657,11 +148339,23 @@ components:
- 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
@@ -78717,6 +148411,7 @@ components:
- changed_object
- changed_object_id
- changed_object_type
+ - display
- id
- object_data
- request_id
@@ -78730,6 +148425,10 @@ components:
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
@@ -78755,6 +148454,10 @@ components:
items:
type: object
properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
id:
type: integer
readOnly: true
@@ -78765,10 +148468,6 @@ components:
name:
type: string
maxLength: 150
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- display
- id
@@ -78779,6 +148478,10 @@ components:
items:
type: object
properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
id:
type: string
format: uuid
@@ -78793,10 +148496,6 @@ components:
@/./+/-/_ only.
pattern: ^[\w.@+-]+$
maxLength: 150
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- display
- id
@@ -78812,10 +148511,6 @@ components:
nullable: true
description: Queryset filter matching the applicable objects of the selected
type(s)
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- actions
- display
@@ -78837,18 +148532,6 @@ components:
ip_address:
type: string
description: IP Address to reach device
- username:
- type: string
- writeOnly: true
- description: Device username
- password:
- type: string
- writeOnly: true
- description: Device password
- secret:
- type: string
- writeOnly: true
- description: Device secret password
port:
type: integer
description: Device PORT to check for online
@@ -78888,11 +148571,62 @@ components:
- 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
- type: string
PaginatedAccessGrantList:
type: object
properties:
@@ -78913,6 +148647,66 @@ components:
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:
@@ -78933,6 +148727,26 @@ components:
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:
@@ -78973,6 +148787,26 @@ components:
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:
@@ -79013,6 +148847,26 @@ components:
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:
@@ -79513,7 +149367,7 @@ components:
type: array
items:
$ref: '#/components/schemas/CustomFieldChoice'
- PaginatedCustomFieldList:
+ PaginatedCustomFieldSerializerVersion12List:
type: object
properties:
count:
@@ -79532,7 +149386,7 @@ components:
results:
type: array
items:
- $ref: '#/components/schemas/CustomField'
+ $ref: '#/components/schemas/CustomFieldSerializerVersion12'
PaginatedCustomLinkList:
type: object
properties:
@@ -79593,6 +149447,26 @@ components:
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:
@@ -79673,6 +149547,26 @@ components:
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:
@@ -79693,6 +149587,26 @@ components:
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:
@@ -79873,6 +149787,26 @@ components:
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:
@@ -79913,7 +149847,7 @@ components:
type: array
items:
$ref: '#/components/schemas/InterfaceConnection'
- PaginatedInterfaceList:
+ PaginatedInterfaceSerializerVersion12List:
type: object
properties:
count:
@@ -79932,7 +149866,7 @@ components:
results:
type: array
items:
- $ref: '#/components/schemas/Interface'
+ $ref: '#/components/schemas/InterfaceSerializerVersion12'
PaginatedInterfaceTemplateList:
type: object
properties:
@@ -79973,6 +149907,26 @@ components:
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:
@@ -80053,6 +150007,46 @@ components:
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:
@@ -80093,6 +150087,46 @@ components:
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:
@@ -80193,6 +150227,106 @@ components:
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:
@@ -80213,6 +150347,46 @@ components:
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:
@@ -80793,6 +150967,46 @@ components:
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:
@@ -80973,6 +151187,46 @@ components:
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:
@@ -81013,7 +151267,7 @@ components:
type: array
items:
$ref: '#/components/schemas/VLAN'
- PaginatedVMInterfaceList:
+ PaginatedVMInterfaceSerializerVersion12List:
type: object
properties:
count:
@@ -81032,7 +151286,7 @@ components:
results:
type: array
items:
- $ref: '#/components/schemas/VMInterface'
+ $ref: '#/components/schemas/VMInterfaceSerializerVersion12'
PaginatedVRFList:
type: object
properties:
@@ -81153,20 +151407,38 @@ components:
type: array
items:
$ref: '#/components/schemas/Webhook'
- PatchedAccessGrant:
+ 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:
- id:
- type: string
- format: uuid
- readOnly: true
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
@@ -81174,31 +151446,693 @@ components:
$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
- display:
+ PatchedBulkWritableAccessGrantRequest:
+ type: object
+ description: API serializer for interacting with AccessGrant objects.
+ properties:
+ id:
type: string
- readOnly: true
- description: Human friendly display value
- PatchedCVELCM:
+ 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
- readOnly: true
- url:
- type: string
- format: uri
- readOnly: true
name:
type: string
+ minLength: 1
maxLength: 16
published_date:
type: string
@@ -81206,6 +152140,7 @@ components:
link:
type: string
format: uri
+ minLength: 1
maxLength: 200
status:
$ref: '#/components/schemas/Status4f5Enum'
@@ -81214,8 +152149,7 @@ components:
nullable: true
maxLength: 255
severity:
- type: string
- maxLength: 50
+ $ref: '#/components/schemas/SeverityEnum'
cvss:
type: number
format: double
@@ -81243,21 +152177,331 @@ components:
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
- display:
+ $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
- readOnly: true
- description: Human friendly display value
- PatchedCircuitMaintenance:
+ 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
- readOnly: true
name:
type: string
+ minLength: 1
maxLength: 100
start_time:
type: string
@@ -81271,47 +152515,340 @@ components:
status:
nullable: true
oneOf:
- - $ref: '#/components/schemas/CircuitMaintenanceStatusEnum'
+ - $ref: '#/components/schemas/StatusD95Enum'
- $ref: '#/components/schemas/BlankEnum'
- $ref: '#/components/schemas/NullEnum'
ack:
type: boolean
nullable: true
- PatchedCircuitMaintenanceCircuitImpact:
+ required:
+ - id
+ PatchedBulkWritableCircuitRequest:
type: object
- description: Serializer for API.
+ description: |-
+ Base class to use for serializers 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
- maintenance:
+ 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:
- type: string
- format: uuid
- impact:
+ $ref: '#/components/schemas/NestedCircuitRequest'
+ term_side:
+ allOf:
+ - $ref: '#/components/schemas/TermSideEnum'
+ title: Termination
+ site:
+ allOf:
+ - $ref: '#/components/schemas/NestedSiteRequest'
nullable: true
- oneOf:
- - $ref: '#/components/schemas/ImpactEnum'
- - $ref: '#/components/schemas/BlankEnum'
- - $ref: '#/components/schemas/NullEnum'
- PatchedCircuitType:
+ 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: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
name:
type: string
+ minLength: 1
maxLength: 100
slug:
type: string
@@ -81320,39 +152857,127 @@ components:
description:
type: string
maxLength: 200
- circuit_count:
- type: integer
- readOnly: true
custom_fields:
type: object
additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedClusterGroup:
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
name:
type: string
+ minLength: 1
maxLength: 100
slug:
type: string
@@ -81361,39 +152986,273 @@ components:
description:
type: string
maxLength: 200
- cluster_count:
- type: integer
- readOnly: true
custom_fields:
type: object
additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedClusterType:
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
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
@@ -81402,32 +153261,121 @@ components:
description:
type: string
maxLength: 200
- cluster_count:
- type: integer
- readOnly: true
custom_fields:
type: object
additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedCommandToken:
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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
- readOnly: true
comment:
type: string
description: 'Optional: Enter description of token'
@@ -81436,96 +153384,57 @@ components:
$ref: '#/components/schemas/PlatformEnum'
token:
type: string
+ minLength: 1
description: Token given by chat platform for signing or command validation
maxLength: 255
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedComplianceFeature:
+ required:
+ - id
+ PatchedBulkWritableComplianceFeatureRequest:
type: object
description: Serializer for ComplianceFeature object.
properties:
id:
type: string
format: uuid
- readOnly: true
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- computed_fields:
- type: object
- additionalProperties: {}
- readOnly: true
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- url:
- type: string
- format: uri
- readOnly: true
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
_custom_field_data:
type: object
additionalProperties: {}
title: ' custom field data'
name:
type: string
+ minLength: 1
maxLength: 100
slug:
type: string
+ minLength: 1
maxLength: 100
pattern: ^[-a-zA-Z0-9_]+$
description:
type: string
maxLength: 200
- PatchedComplianceRule:
+ required:
+ - id
+ PatchedBulkWritableComplianceRuleRequest:
type: object
description: Serializer for ComplianceRule object.
properties:
id:
type: string
format: uuid
- readOnly: true
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- computed_fields:
- type: object
- additionalProperties: {}
- readOnly: true
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- url:
- type: string
- format: uri
- readOnly: true
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
_custom_field_data:
type: object
additionalProperties: {}
@@ -81554,7 +153463,9 @@ components:
platform:
type: string
format: uuid
- PatchedComputedField:
+ required:
+ - id
+ PatchedBulkWritableComputedFieldRequest:
type: object
description: |-
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
@@ -81563,18 +153474,15 @@ components:
id:
type: string
format: uuid
- readOnly: true
- url:
- type: string
- format: uri
- readOnly: true
slug:
type: string
- description: Internal field name
+ 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:
@@ -81584,6 +153492,7 @@ components:
type: string
template:
type: string
+ minLength: 1
description: Jinja2 template code for field value
maxLength: 500
fallback_value:
@@ -81595,41 +153504,22 @@ components:
type: integer
maximum: 32767
minimum: 0
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedConfigCompliance:
+ required:
+ - id
+ PatchedBulkWritableConfigComplianceRequest:
type: object
description: Serializer for ConfigCompliance object.
properties:
id:
type: string
format: uuid
- readOnly: true
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- computed_fields:
- type: object
- additionalProperties: {}
- readOnly: true
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
_custom_field_data:
type: object
additionalProperties: {}
@@ -81667,7 +153557,9 @@ components:
rule:
type: string
format: uuid
- PatchedConfigContextSchema:
+ required:
+ - id
+ PatchedBulkWritableConfigContextRequest:
type: object
description: |-
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
@@ -81676,13 +153568,199 @@ components:
id:
type: string
format: uuid
- readOnly: true
- url:
- type: string
- format: uri
- readOnly: true
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
@@ -81695,11 +153773,6 @@ components:
type: string
format: uuid
nullable: true
- owner:
- type: object
- additionalProperties: {}
- nullable: true
- readOnly: true
description:
type: string
maxLength: 200
@@ -81708,131 +153781,1030 @@ components:
additionalProperties: {}
description: A JSON Schema document which is used to validate a config context
object.
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedConfigRemove:
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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
- readOnly: true
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- computed_fields:
- type: object
- additionalProperties: {}
- readOnly: true
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- url:
- type: string
- format: uri
- readOnly: true
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
_custom_field_data:
type: object
additionalProperties: {}
title: ' custom field data'
name:
type: string
+ 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
- PatchedConfigReplace:
+ required:
+ - id
+ PatchedBulkWritableConfigReplaceRequest:
type: object
description: Serializer for ConfigReplace object.
properties:
id:
type: string
format: uuid
- readOnly: true
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- computed_fields:
- type: object
- additionalProperties: {}
- readOnly: true
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- url:
- type: string
- format: uri
- readOnly: true
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
_custom_field_data:
type: object
additionalProperties: {}
title: ' custom field data'
name:
type: string
+ 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
- PatchedCustomLink:
+ 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
@@ -81841,24 +154813,44 @@ components:
id:
type: string
format: uuid
- readOnly: true
- url:
+ field:
+ $ref: '#/components/schemas/NestedCustomFieldRequest'
+ value:
type: string
- format: uri
- readOnly: true
+ 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.
@@ -81879,25 +154871,434 @@ components:
new_window:
type: boolean
description: Force link to open in a new window
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedDeviceRole:
+ required:
+ - id
+ PatchedBulkWritableDeviceBayRequest:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
+ 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
@@ -81905,6 +155306,7 @@ components:
pattern: ^[-a-zA-Z0-9_]+$
color:
type: string
+ minLength: 1
pattern: ^[0-9a-f]{6}$
maxLength: 6
vm_role:
@@ -81913,28 +155315,487 @@ components:
description:
type: string
maxLength: 200
- device_count:
- type: integer
- readOnly: true
- virtualmachine_count:
- type: integer
- readOnly: true
custom_fields:
type: object
additionalProperties: {}
- created:
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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: date
- readOnly: true
- last_updated:
+ format: uuid
+ manufacturer:
+ $ref: '#/components/schemas/NestedManufacturerRequest'
+ model:
type: string
- format: date-time
- readOnly: true
- display:
+ minLength: 1
+ maxLength: 100
+ slug:
type: string
- readOnly: true
- description: Human friendly display value
- PatchedDynamicGroup:
+ 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
@@ -81943,13 +155804,31 @@ components:
id:
type: string
format: uuid
- readOnly: true
- url:
+ 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: uri
- readOnly: true
+ format: uuid
name:
type: string
+ minLength: 1
description: Dynamic Group name
maxLength: 100
slug:
@@ -81966,24 +155845,121 @@ components:
type: object
additionalProperties: {}
description: A JSON-encoded dictionary of filter parameters for group membership
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedExportTemplate:
+ custom_fields:
+ type: object
+ additionalProperties: {}
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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: |-
- 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)
+ description: Extend ValidatedModelSerializer with a `relationships` field.
properties:
id:
type: string
format: uuid
- readOnly: true
- url:
- type: string
- format: uri
- readOnly: true
content_type:
type: string
owner_content_type:
@@ -81993,19 +155969,16 @@ components:
type: string
format: uuid
nullable: true
- owner:
- type: object
- additionalProperties: {}
- nullable: true
- readOnly: 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:
@@ -82016,45 +155989,707 @@ components:
type: string
description: Extension to append to the rendered filename
maxLength: 15
- display:
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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
- readOnly: true
- description: Human friendly display value
- PatchedGoldenConfig:
+ 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
- readOnly: true
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- computed_fields:
- type: object
- additionalProperties: {}
- readOnly: true
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- url:
- type: string
- format: uri
- readOnly: true
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
_custom_field_data:
type: object
additionalProperties: {}
@@ -82096,50 +156731,38 @@ components:
type: string
format: uuid
description: device
- PatchedGoldenConfigSetting:
+ required:
+ - id
+ PatchedBulkWritableGoldenConfigSettingRequest:
type: object
description: Serializer for GoldenConfigSetting object.
properties:
id:
type: string
format: uuid
- readOnly: true
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- computed_fields:
- type: object
- additionalProperties: {}
- readOnly: true
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- url:
- type: string
- format: uri
- readOnly: true
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
+ 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:
@@ -82173,12 +156796,6 @@ components:
title: Backup Test
description: Whether or not to pretest the connectivity of the device by
verifying there is a resolvable IP that can connect to port 22.
- scope:
- type: object
- additionalProperties: {}
- nullable: true
- description: API filter in JSON format matching the list of devices for
- the scope of devices to be considered.
backup_repository:
type: string
format: uuid
@@ -82195,7 +156812,9 @@ components:
type: string
format: uuid
nullable: true
- PatchedGraphQLQuery:
+ required:
+ - id
+ PatchedBulkWritableGraphQLQueryRequest:
type: object
description: |-
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
@@ -82204,13 +156823,9 @@ components:
id:
type: string
format: uuid
- readOnly: true
- url:
- type: string
- format: uri
- readOnly: true
name:
type: string
+ minLength: 1
maxLength: 100
slug:
type: string
@@ -82218,16 +156833,15 @@ components:
pattern: ^[-a-zA-Z0-9_]+$
query:
type: string
+ minLength: 1
variables:
type: object
additionalProperties: {}
nullable: true
default: {}
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedGroup:
+ required:
+ - id
+ PatchedBulkWritableGroupRequest:
type: object
description: |-
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
@@ -82235,22 +156849,460 @@ components:
properties:
id:
type: integer
- readOnly: true
- url:
- type: string
- format: uri
- readOnly: true
name:
type: string
+ minLength: 1
maxLength: 150
- user_count:
- type: integer
- readOnly: true
- display:
+ required:
+ - id
+ PatchedBulkWritableHardwareLCMRequest:
+ type: object
+ description: API serializer.
+ properties:
+ id:
type: string
- readOnly: true
- description: Human friendly display value
- PatchedImageAttachment:
+ 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
@@ -82259,26 +157311,17 @@ components:
id:
type: string
format: uuid
- readOnly: true
- url:
- type: string
- format: uri
- readOnly: true
content_type:
type: string
object_id:
type: string
format: uuid
- parent:
- type: object
- additionalProperties: {}
- readOnly: true
name:
type: string
maxLength: 50
image:
type: string
- format: uri
+ format: binary
image_height:
type: integer
maximum: 32767
@@ -82287,42 +157330,646 @@ components:
type: integer
maximum: 32767
minimum: 0
- created:
- type: string
- format: date-time
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedJob:
+ required:
+ - id
+ PatchedBulkWritableInterfaceRequest:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
+ device:
+ $ref: '#/components/schemas/NestedDeviceRequest'
+ name:
type: string
- format: uri
- readOnly: true
- source:
+ minLength: 1
+ maxLength: 64
+ label:
type: string
- readOnly: true
- description: Source of the Python code for this job - local, Git repository,
- or plugins
- module_name:
+ 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
- readOnly: true
- description: Dotted name of the Python module providing this job
- job_class_name:
+ 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
- readOnly: true
- description: Name of the Python class providing this job
+ 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:
@@ -82331,6 +157978,7 @@ components:
Job source code changes
name:
type: string
+ minLength: 1
description: Human-readable name of this job
maxLength: 100
name_override:
@@ -82348,14 +157996,16 @@ components:
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
+ 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
@@ -82407,88 +158057,430 @@ components:
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'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedJobResult:
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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
- readOnly: true
- url:
- type: string
- format: uri
- readOnly: true
- created:
- type: string
- format: date-time
- readOnly: true
- completed:
- type: string
- format: date-time
- nullable: true
name:
type: string
- maxLength: 255
- job_model:
- allOf:
- - $ref: '#/components/schemas/NestedJob'
- readOnly: true
- obj_type:
+ minLength: 1
+ maxLength: 100
+ slug:
type: string
- readOnly: true
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
status:
+ $ref: '#/components/schemas/LocationStatusChoices'
+ location_type:
+ $ref: '#/components/schemas/NestedLocationTypeRequest'
+ parent:
allOf:
- - $ref: '#/components/schemas/JobResultStatusEnum'
- readOnly: true
- user:
+ - $ref: '#/components/schemas/NestedLocationRequest'
+ nullable: true
+ site:
allOf:
- - $ref: '#/components/schemas/NestedUser'
- readOnly: true
- data:
+ - $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: {}
- nullable: true
- job_id:
- type: string
- format: uuid
- schedule:
- allOf:
- - $ref: '#/components/schemas/NestedScheduledJob'
- readOnly: true
- PatchedManufacturer:
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
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
@@ -82497,53 +158489,135 @@ components:
description:
type: string
maxLength: 200
- devicetype_count:
- type: integer
- readOnly: true
- inventoryitem_count:
- type: integer
- readOnly: true
- platform_count:
- type: integer
- readOnly: true
custom_fields:
type: object
additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedMinMaxValidationRule:
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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
- readOnly: true
- url:
- type: string
- format: uri
- readOnly: true
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
@@ -82564,49 +158638,8615 @@ components:
nullable: true
description: Optional error message to display when validation fails.
maxLength: 255
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedNote:
+ required:
+ - id
+ PatchedBulkWritableNATPolicyRequest:
type: object
- description: Serializer for API.
+ description: NATPolicy Serializer.
properties:
id:
type: string
format: uuid
- readOnly: true
- maintenance:
- type: string
- format: uuid
- title:
+ 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
- comment:
+ name:
type: string
- PatchedProvider:
+ minLength: 1
+ maxLength: 100
+ tenant:
+ type: string
+ format: uuid
+ nullable: true
+ required:
+ - id
+ PatchedBulkWritableNATPolicyRuleRequest:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: PolicyRule Serializer.
properties:
id:
type: string
format: uuid
- readOnly: true
- url:
- type: string
- format: uri
- readOnly: true
+ 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
@@ -82636,78 +167276,128 @@ components:
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- circuit_count:
- type: integer
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedProviderLCM:
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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: API serializer.
+ description: |-
+ Base class to use for serializers 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
- name:
- type: string
- maxLength: 100
- description:
- type: string
- maxLength: 200
- physical_address:
- type: string
- maxLength: 200
- phone:
- type: string
- maxLength: 20
- email:
- type: string
- format: email
- title: E-mail
- maxLength: 254
- comments:
- type: string
- custom_fields:
- type: object
- additionalProperties: {}
- tags:
- type: array
- items:
- $ref: '#/components/schemas/TagSerializerField'
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedRIR:
- type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
- properties:
- id:
- type: string
- format: uuid
- readOnly: true
- url:
- type: string
- format: uri
- readOnly: true
name:
type: string
+ minLength: 1
maxLength: 100
slug:
type: string
@@ -82720,39 +167410,593 @@ components:
description:
type: string
maxLength: 200
- aggregate_count:
- type: integer
- readOnly: true
custom_fields:
type: object
additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedRackRole:
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
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
@@ -82760,55 +168004,556 @@ components:
pattern: ^[-a-zA-Z0-9_]+$
color:
type: string
+ minLength: 1
pattern: ^[0-9a-f]{6}$
maxLength: 6
description:
type: string
maxLength: 200
- rack_count:
- type: integer
- readOnly: true
custom_fields:
type: object
additionalProperties: {}
- created:
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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: date
- readOnly: true
- last_updated:
+ format: uuid
+ device:
+ $ref: '#/components/schemas/NestedDeviceRequest'
+ name:
type: string
- format: date-time
- readOnly: true
- display:
+ minLength: 1
+ maxLength: 64
+ label:
type: string
- readOnly: true
- description: Human friendly display value
- PatchedRegularExpressionValidationRule:
+ 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
- readOnly: true
- url:
- type: string
- format: uri
- readOnly: true
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:
@@ -82816,35 +168561,49 @@ components:
nullable: true
description: Optional error message to display when validation fails.
maxLength: 255
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedRelationship:
+ 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
- readOnly: true
- url:
+ relationship:
+ $ref: '#/components/schemas/NestedRelationshipRequest'
+ source_type:
type: string
- format: uri
- readOnly: true
+ 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
- description: Internal relationship name
+ 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:
@@ -82854,6 +168613,12 @@ components:
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:
@@ -82869,8 +168634,8 @@ components:
type: object
additionalProperties: {}
nullable: true
- description: Queryset filter matching the applicable source objects of the
- selected type
+ description: Filterset filter matching the applicable source objects of
+ the selected type
destination_type:
type: string
destination_label:
@@ -82886,23 +168651,23 @@ components:
type: object
additionalProperties: {}
nullable: true
- description: Queryset filter matching the applicable destination objects
+ description: Filterset filter matching the applicable destination objects
of the selected type
- PatchedRole:
+ required:
+ - id
+ PatchedBulkWritableRoleRequest:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
name:
type: string
+ minLength: 1
maxLength: 100
slug:
type: string
@@ -82915,41 +168680,258 @@ components:
description:
type: string
maxLength: 200
- prefix_count:
- type: integer
- readOnly: true
- vlan_count:
- type: integer
- readOnly: true
custom_fields:
type: object
additionalProperties: {}
- created:
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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: date
- readOnly: true
- last_updated:
+ format: uuid
+ name:
type: string
- format: date-time
- readOnly: true
- display:
+ 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
- readOnly: true
- description: Human friendly display value
- PatchedSecret:
+ 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
- readOnly: true
- url:
- type: string
- format: uri
- readOnly: true
name:
type: string
+ minLength: 1
maxLength: 100
slug:
type: string
@@ -82960,6 +168942,7 @@ components:
maxLength: 200
provider:
type: string
+ minLength: 1
maxLength: 100
parameters:
type: object
@@ -82967,36 +168950,142 @@ components:
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- created:
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedSecretsGroup:
+ 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
- readOnly: true
- url:
- type: string
- format: uri
- readOnly: true
name:
type: string
+ minLength: 1
maxLength: 100
slug:
type: string
@@ -83005,44 +169094,1344 @@ components:
description:
type: string
maxLength: 200
- secrets:
- type: array
- items:
- $ref: '#/components/schemas/NestedSecretsGroupAssociation'
- readOnly: true
custom_fields:
type: object
additionalProperties: {}
- created:
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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
- readOnly: true
- last_updated:
+ nullable: true
+ end_of_support:
type: string
- format: date-time
- readOnly: true
- display:
+ format: date
+ nullable: true
+ title: End of Software Support
+ documentation_url:
type: string
- readOnly: true
- description: Human friendly display value
- PatchedStatus:
+ 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
- readOnly: true
- url:
- type: string
- format: uri
- readOnly: true
content_types:
type: array
items:
type: string
name:
type: string
+ minLength: 1
maxLength: 50
slug:
type: string
@@ -83050,53 +170439,144 @@ components:
pattern: ^[-a-zA-Z0-9_]+$
color:
type: string
+ minLength: 1
pattern: ^[0-9a-f]{6}$
maxLength: 6
custom_fields:
type: object
additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedTagSerializerVersion13:
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
name:
type: string
+ minLength: 1
maxLength: 100
slug:
type: string
+ minLength: 1
+ pattern: ^[-\w]+$
maxLength: 100
- pattern: ^[-a-zA-Z0-9_]+$
color:
type: string
+ minLength: 1
pattern: ^[0-9a-f]{6}$
maxLength: 6
description:
type: string
maxLength: 200
- tagged_items:
- type: integer
- readOnly: true
content_types:
type: array
items:
@@ -83104,19 +170584,382 @@ components:
custom_fields:
type: object
additionalProperties: {}
- created:
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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: date
- readOnly: true
- last_updated:
+ format: uuid
+ name:
type: string
- format: date-time
- readOnly: true
- display:
+ minLength: 1
+ maxLength: 100
+ slug:
type: string
- readOnly: true
- description: Human friendly display value
- PatchedToken:
+ 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
@@ -83125,19 +170968,6 @@ components:
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
@@ -83152,48 +170982,413 @@ components:
description:
type: string
maxLength: 200
- PatchedVulnerabilityLCM:
+ required:
+ - id
+ PatchedBulkWritableUserObjectGroupRequest:
type: object
- description: REST API serializer for VulnerabilityLCM records.
+ description: UserObjectGroup 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
- cve:
- allOf:
- - $ref: '#/components/schemas/NestedCVELCM'
- readOnly: true
- software:
- allOf:
- - $ref: '#/components/schemas/NestedSoftwareLCM'
- readOnly: true
- device:
- allOf:
- - $ref: '#/components/schemas/NestedDevice'
- readOnly: true
- inventory_item:
- allOf:
- - $ref: '#/components/schemas/NestedInventoryItem'
- readOnly: true
- status:
- $ref: '#/components/schemas/Status4f5Enum'
- custom_fields:
- type: object
- additionalProperties: {}
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
- PatchedWebhook:
+ $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
@@ -83202,17 +171397,1296 @@ components:
id:
type: string
format: uuid
- readOnly: true
- url:
+ username:
type: string
- format: uri
- readOnly: true
+ 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
@@ -83225,6 +172699,7 @@ components:
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
@@ -83232,6 +172707,7 @@ components:
$ref: '#/components/schemas/HttpMethodEnum'
http_content_type:
type: string
+ minLength: 1
description: The complete list of official content types is available here.
maxLength: 100
@@ -83262,29 +172738,4606 @@ components:
description: The specific CA certificate file to use for SSL verification.
Leave blank to use the system defaults.
maxLength: 4096
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritableAggregate:
+ required:
+ - id
+ PatchedBulkWritableZoneRequest:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: Zone Serializer.
properties:
id:
type: string
format: uuid
- readOnly: true
- url:
+ 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
- readOnly: true
- family:
+ 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/FamilyEnum'
- readOnly: true
+ - $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
@@ -83302,64 +177355,337 @@ components:
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritableCable:
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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: Mixin to add `status` choice field to model serializers.
+ description: REST API serializer for AutonomousSystem records.
properties:
- id:
+ 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
- readOnly: true
- url:
+ 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
- readOnly: true
+ 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_a:
- type: object
- additionalProperties: {}
- nullable: true
- readOnly: true
termination_b_type:
type: string
termination_b_id:
type: string
format: uuid
- termination_b:
- type: object
- additionalProperties: {}
- nullable: true
- readOnly: true
type:
oneOf:
- $ref: '#/components/schemas/CableTypeChoices'
- $ref: '#/components/schemas/BlankEnum'
status:
- $ref: '#/components/schemas/WritableCableStatusEnum'
+ $ref: '#/components/schemas/CableStatusChoices'
label:
type: string
maxLength: 100
@@ -83379,32 +177705,123 @@ components:
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritableCircuit:
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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: Mixin to add `status` choice field to model serializers.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
cid:
type: string
+ minLength: 1
title: Circuit ID
maxLength: 100
provider:
@@ -83414,7 +177831,7 @@ components:
type: string
format: uuid
status:
- $ref: '#/components/schemas/WritableCircuitStatusEnum'
+ $ref: '#/components/schemas/CircuitStatusChoices'
tenant:
type: string
format: uuid
@@ -83433,53 +177850,125 @@ components:
description:
type: string
maxLength: 200
- termination_a:
- allOf:
- - $ref: '#/components/schemas/CircuitCircuitTermination'
- readOnly: true
- termination_z:
- allOf:
- - $ref: '#/components/schemas/CircuitCircuitTermination'
- readOnly: true
comments:
type: string
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritableCircuitTermination:
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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: |-
- 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)
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
circuit:
type: string
format: uuid
@@ -83491,6 +177980,10 @@ components:
type: string
format: uuid
nullable: true
+ location:
+ type: string
+ format: uuid
+ nullable: true
provider_network:
type: string
format: uuid
@@ -83519,51 +178012,122 @@ components:
description:
type: string
maxLength: 200
- cable:
- allOf:
- - $ref: '#/components/schemas/NestedCable'
- readOnly: true
- cable_peer:
+ custom_fields:
type: object
additionalProperties: {}
- nullable: true
- readOnly: true
- cable_peer_type:
- type: string
- nullable: true
- readOnly: true
- connected_endpoint:
+ relationships:
type: object
- additionalProperties: {}
- nullable: true
- readOnly: true
- connected_endpoint_type:
- type: string
- nullable: true
- readOnly: true
- connected_endpoint_reachable:
- type: boolean
- nullable: true
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritableCluster:
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
name:
type: string
+ minLength: 1
maxLength: 100
type:
type: string
@@ -83580,53 +178144,131 @@ components:
type: string
format: uuid
nullable: true
+ location:
+ type: string
+ format: uuid
+ nullable: true
comments:
type: string
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- device_count:
- type: integer
- readOnly: true
- virtualmachine_count:
- type: integer
- readOnly: true
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritableConfigContext:
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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:
- id:
- type: string
- format: uuid
- readOnly: true
- url:
- type: string
- format: uri
- readOnly: true
name:
type: string
+ minLength: 1
maxLength: 100
owner_content_type:
type: string
@@ -83635,11 +178277,6 @@ components:
type: string
format: uuid
nullable: true
- owner:
- type: object
- additionalProperties: {}
- nullable: true
- readOnly: true
weight:
type: integer
maximum: 32767
@@ -83664,6 +178301,11 @@ components:
items:
type: string
format: uuid
+ locations:
+ type: array
+ items:
+ type: string
+ format: uuid
roles:
type: array
items:
@@ -83706,36 +178348,19 @@ components:
data:
type: object
additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritableConsolePort:
+ PatchedWritableConsolePortRequest:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
device:
type: string
format: uuid
name:
type: string
+ minLength: 1
maxLength: 64
label:
type: string
@@ -83749,65 +178374,129 @@ components:
description:
type: string
maxLength: 200
- cable:
- allOf:
- - $ref: '#/components/schemas/NestedCable'
- readOnly: true
- cable_peer:
- type: object
- additionalProperties: {}
- nullable: true
- readOnly: true
- cable_peer_type:
- type: string
- nullable: true
- readOnly: true
- connected_endpoint:
- type: object
- additionalProperties: {}
- nullable: true
- readOnly: true
- connected_endpoint_type:
- type: string
- nullable: true
- readOnly: true
- connected_endpoint_reachable:
- type: boolean
- nullable: true
- readOnly: true
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritableConsolePortTemplate:
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
device_type:
type: string
format: uuid
name:
type: string
+ minLength: 1
maxLength: 64
label:
type: string
@@ -83823,32 +178512,122 @@ components:
custom_fields:
type: object
additionalProperties: {}
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritableConsoleServerPort:
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
device:
type: string
format: uuid
name:
type: string
+ minLength: 1
maxLength: 64
label:
type: string
@@ -83862,65 +178641,129 @@ components:
description:
type: string
maxLength: 200
- cable:
- allOf:
- - $ref: '#/components/schemas/NestedCable'
- readOnly: true
- cable_peer:
- type: object
- additionalProperties: {}
- nullable: true
- readOnly: true
- cable_peer_type:
- type: string
- nullable: true
- readOnly: true
- connected_endpoint:
- type: object
- additionalProperties: {}
- nullable: true
- readOnly: true
- connected_endpoint_type:
- type: string
- nullable: true
- readOnly: true
- connected_endpoint_reachable:
- type: boolean
- nullable: true
- readOnly: true
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritableConsoleServerPortTemplate:
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
device_type:
type: string
format: uuid
name:
type: string
+ minLength: 1
maxLength: 64
label:
type: string
@@ -83936,17 +178779,117 @@ components:
custom_fields:
type: object
additionalProperties: {}
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritableContactLCM:
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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
@@ -83975,19 +178918,114 @@ components:
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritableContractLCM:
+ $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:
- id:
- type: string
- format: uuid
- readOnly: true
provider:
type: string
format: uuid
@@ -83995,6 +179033,7 @@ components:
title: Vendor
name:
type: string
+ minLength: 1
maxLength: 100
start:
type: string
@@ -84020,151 +179059,147 @@ components:
type: string
nullable: true
maxLength: 32
- expired:
- type: string
- readOnly: true
custom_fields:
type: object
additionalProperties: {}
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritableCustomField:
- type: object
- description: |-
- Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
- validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)
- properties:
- id:
- type: string
- format: uuid
- readOnly: true
- url:
- type: string
- format: uri
- readOnly: true
- content_types:
- type: array
- items:
- type: string
- type:
- allOf:
- - $ref: '#/components/schemas/CustomFieldTypeChoices'
- description: The type of value(s) allowed for this field.
- name:
- type: string
- title: Slug
- description: URL-friendly unique shorthand.
- maxLength: 50
- label:
- type: string
- description: Name of the field as displayed to users (if not provided, the
- field's slug will be used.)
- maxLength: 50
- description:
- type: string
- description: A helpful description for this field.
- maxLength: 200
- required:
- type: boolean
- description: If true, this field is required when creating new objects or
- editing an existing object.
- filter_logic:
- allOf:
- - $ref: '#/components/schemas/FilterLogicEnum'
- description: Loose matches any instance of a given string; Exact matches
- the entire field.
- default:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ relationships:
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
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritableCustomFieldChoice:
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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:
- id:
- type: string
- format: uuid
- readOnly: true
- url:
- type: string
- format: uri
- readOnly: true
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
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritableDeviceBay:
+ PatchedWritableDeviceBayRequest:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
device:
type: string
format: uuid
name:
type: string
+ minLength: 1
maxLength: 64
label:
type: string
@@ -84180,36 +179215,126 @@ components:
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritableDeviceBayTemplate:
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
device_type:
type: string
format: uuid
name:
type: string
+ minLength: 1
maxLength: 64
label:
type: string
@@ -84221,32 +179346,262 @@ components:
custom_fields:
type: object
additionalProperties: {}
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritableDeviceType:
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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:
+ 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
- readOnly: true
- url:
+ nullable: true
+ comments:
type: string
- format: uri
- readOnly: true
+ 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
@@ -84273,50 +179628,129 @@ components:
- $ref: '#/components/schemas/BlankEnum'
front_image:
type: string
- format: uri
+ format: binary
rear_image:
type: string
- format: uri
+ format: binary
comments:
type: string
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- device_count:
- type: integer
- readOnly: true
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritableDeviceWithConfigContext:
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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: Mixin to add `status` choice field to model serializers.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
name:
type: string
nullable: true
@@ -84347,6 +179781,10 @@ components:
site:
type: string
format: uuid
+ location:
+ type: string
+ format: uuid
+ nullable: true
rack:
type: string
format: uuid
@@ -84363,16 +179801,8 @@ components:
oneOf:
- $ref: '#/components/schemas/FaceEnum'
- $ref: '#/components/schemas/BlankEnum'
- parent_device:
- allOf:
- - $ref: '#/components/schemas/NestedDevice'
- readOnly: true
status:
- $ref: '#/components/schemas/WritableDeviceWithConfigContextStatusEnum'
- primary_ip:
- allOf:
- - $ref: '#/components/schemas/NestedIPAddress'
- readOnly: true
+ $ref: '#/components/schemas/DeviceStatusChoices'
primary_ip4:
type: string
format: uuid
@@ -84405,6 +179835,16 @@ components:
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:
@@ -84419,48 +179859,272 @@ components:
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
- computed_fields:
- type: object
- additionalProperties: {}
- readOnly: true
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- config_context:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritableFrontPort:
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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 ModelSerializer to render any CustomFields and their values
- associated with an 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:
+ group:
type: string
format: uuid
- readOnly: true
- url:
+ parent_group:
type: string
- format: uri
- readOnly: true
+ 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
@@ -84479,52 +180143,129 @@ components:
description:
type: string
maxLength: 200
- cable:
- allOf:
- - $ref: '#/components/schemas/NestedCable'
- readOnly: true
- cable_peer:
- type: object
- additionalProperties: {}
- nullable: true
- readOnly: true
- cable_peer_type:
- type: string
- nullable: true
- readOnly: true
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritableFrontPortTemplate:
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
device_type:
type: string
format: uuid
name:
type: string
+ minLength: 1
maxLength: 64
label:
type: string
@@ -84546,28 +180287,116 @@ components:
custom_fields:
type: object
additionalProperties: {}
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritableGitRepository:
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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:
- id:
- type: string
- format: uuid
- readOnly: true
- url:
- type: string
- format: uri
- readOnly: true
name:
type: string
+ minLength: 1
maxLength: 100
slug:
type: string
@@ -84576,14 +180405,17 @@ components:
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
@@ -84602,42 +180434,193 @@ components:
oneOf:
- $ref: '#/components/schemas/ProvidedContentsEnum'
- $ref: '#/components/schemas/BlankEnum'
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
custom_fields:
type: object
additionalProperties: {}
- computed_fields:
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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: {}
- readOnly: true
- display:
+ scope:
+ type: object
+ additionalProperties: {}
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ name:
type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritableHardwareLCM:
+ 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:
- id:
- type: string
- format: uuid
- readOnly: true
- expired:
- type: string
- readOnly: true
- devices:
- type: array
- items:
- $ref: '#/components/schemas/NestedDevice'
- readOnly: true
- description: Devices tied to Device Type
device_type:
type: string
format: uuid
@@ -84678,29 +180661,120 @@ components:
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritableIPAddress:
+ $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: Mixin to add `status` choice field to model serializers.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
- family:
- allOf:
- - $ref: '#/components/schemas/FamilyEnum'
- readOnly: true
address:
type: string
+ minLength: 1
vrf:
type: string
format: uuid
@@ -84710,7 +180784,7 @@ components:
format: uuid
nullable: true
status:
- $ref: '#/components/schemas/WritableIPAddressStatusEnum'
+ $ref: '#/components/schemas/IPAddressStatusChoices'
role:
description: The functional role of this IP
oneOf:
@@ -84723,22 +180797,12 @@ components:
type: string
format: uuid
nullable: true
- assigned_object:
- type: object
- additionalProperties: {}
- nullable: true
- readOnly: true
nat_inside:
type: string
format: uuid
nullable: true
title: NAT (Inside)
description: The IP Addresses for which this address is the "outside" IP
- nat_outside:
- type: array
- items:
- $ref: '#/components/schemas/NestedIPAddress'
- readOnly: true
dns_name:
type: string
description: Hostname or FQDN (not case-sensitive)
@@ -84750,58 +180814,154 @@ components:
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritableInterface:
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
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
@@ -84832,68 +180992,129 @@ components:
type: string
format: uuid
title: Tagged VLANs
- cable:
- allOf:
- - $ref: '#/components/schemas/NestedCable'
- readOnly: true
- cable_peer:
- type: object
- additionalProperties: {}
- nullable: true
- readOnly: true
- cable_peer_type:
- type: string
- nullable: true
- readOnly: true
- connected_endpoint:
- type: object
- additionalProperties: {}
- nullable: true
- readOnly: true
- connected_endpoint_type:
- type: string
- nullable: true
- readOnly: true
- connected_endpoint_reachable:
- type: boolean
- nullable: true
- readOnly: true
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
- count_ipaddresses:
- type: integer
- readOnly: true
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritableInterfaceTemplate:
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
device_type:
type: string
format: uuid
name:
type: string
+ minLength: 1
maxLength: 64
label:
type: string
@@ -84910,27 +181131,116 @@ components:
custom_fields:
type: object
additionalProperties: {}
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritableInventoryItem:
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
device:
type: string
format: uuid
@@ -84940,6 +181250,7 @@ components:
nullable: true
name:
type: string
+ minLength: 1
maxLength: 64
label:
type: string
@@ -84971,38 +181282,548 @@ components:
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
- _depth:
- type: integer
- readOnly: true
- title: ' depth'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- computed_fields:
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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: {}
- readOnly: true
- display:
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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
- readOnly: true
- description: Human friendly display value
- PatchedWritableObjectPermission:
+ 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:
- id:
- type: string
- format: uuid
- readOnly: true
- url:
- type: string
- format: uri
- readOnly: true
name:
type: string
+ minLength: 1
maxLength: 100
description:
type: string
@@ -85032,25 +181853,152 @@ components:
nullable: true
description: Queryset filter matching the applicable objects of the selected
type(s)
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritablePlatform:
+ PatchedWritablePeerEndpointRequest:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: REST API serializer for PeerEndpoint records.
properties:
- id:
+ routing_instance:
type: string
format: uuid
- readOnly: true
- url:
+ nullable: true
+ title: BGP Routing Instance
+ source_ip:
type: string
- format: uri
- readOnly: true
+ 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
@@ -85076,43 +182024,264 @@ components:
description:
type: string
maxLength: 200
- device_count:
- type: integer
- readOnly: true
- virtualmachine_count:
- type: integer
- readOnly: true
custom_fields:
type: object
additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- computed_fields:
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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: {}
- readOnly: true
- display:
+ 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
- readOnly: true
- description: Human friendly display value
- PatchedWritablePowerFeed:
+ 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: Mixin to add `status` choice field to model serializers.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
power_panel:
type: string
format: uuid
@@ -85122,9 +182291,10 @@ components:
nullable: true
name:
type: string
+ minLength: 1
maxLength: 100
status:
- $ref: '#/components/schemas/WritablePowerFeedStatusEnum'
+ $ref: '#/components/schemas/PowerFeedStatusChoices'
type:
$ref: '#/components/schemas/PowerFeedTypeChoices'
supply:
@@ -85146,73 +182316,129 @@ components:
description: Maximum permissible draw (percentage)
comments:
type: string
- cable:
- allOf:
- - $ref: '#/components/schemas/NestedCable'
- readOnly: true
- cable_peer:
- type: object
- additionalProperties: {}
- nullable: true
- readOnly: true
- cable_peer_type:
- type: string
- nullable: true
- readOnly: true
- connected_endpoint:
- type: object
- additionalProperties: {}
- nullable: true
- readOnly: true
- connected_endpoint_type:
- type: string
- nullable: true
- readOnly: true
- connected_endpoint_reachable:
- type: boolean
- nullable: true
- readOnly: true
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritablePowerOutlet:
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
device:
type: string
format: uuid
name:
type: string
+ minLength: 1
maxLength: 64
label:
type: string
@@ -85235,65 +182461,129 @@ components:
description:
type: string
maxLength: 200
- cable:
- allOf:
- - $ref: '#/components/schemas/NestedCable'
- readOnly: true
- cable_peer:
- type: object
- additionalProperties: {}
- nullable: true
- readOnly: true
- cable_peer_type:
- type: string
- nullable: true
- readOnly: true
- connected_endpoint:
- type: object
- additionalProperties: {}
- nullable: true
- readOnly: true
- connected_endpoint_type:
- type: string
- nullable: true
- readOnly: true
- connected_endpoint_reachable:
- type: boolean
- nullable: true
- readOnly: true
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritablePowerOutletTemplate:
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
device_type:
type: string
format: uuid
name:
type: string
+ minLength: 1
maxLength: 64
label:
type: string
@@ -85318,73 +182608,254 @@ components:
custom_fields:
type: object
additionalProperties: {}
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritablePowerPanel:
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
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/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- powerfeed_count:
- type: integer
- readOnly: true
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritablePowerPort:
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
device:
type: string
format: uuid
name:
type: string
+ minLength: 1
maxLength: 64
label:
type: string
@@ -85410,65 +182881,129 @@ components:
description:
type: string
maxLength: 200
- cable:
- allOf:
- - $ref: '#/components/schemas/NestedCable'
- readOnly: true
- cable_peer:
- type: object
- additionalProperties: {}
- nullable: true
- readOnly: true
- cable_peer_type:
- type: string
- nullable: true
- readOnly: true
- connected_endpoint:
- type: object
- additionalProperties: {}
- nullable: true
- readOnly: true
- connected_endpoint_type:
- type: string
- nullable: true
- readOnly: true
- connected_endpoint_reachable:
- type: boolean
- nullable: true
- readOnly: true
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritablePowerPortTemplate:
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
device_type:
type: string
format: uuid
name:
type: string
+ minLength: 1
maxLength: 64
label:
type: string
@@ -85496,36 +183031,127 @@ components:
custom_fields:
type: object
additionalProperties: {}
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritablePrefix:
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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: Mixin to add `status` choice field to model serializers.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
- family:
- allOf:
- - $ref: '#/components/schemas/FamilyEnum'
- readOnly: true
prefix:
type: string
+ minLength: 1
site:
type: string
format: uuid
nullable: true
+ location:
+ type: string
+ format: uuid
+ nullable: true
vrf:
type: string
format: uuid
@@ -85539,7 +183165,7 @@ components:
format: uuid
nullable: true
status:
- $ref: '#/components/schemas/WritablePrefixStatusEnum'
+ $ref: '#/components/schemas/PrefixStatusChoices'
role:
type: string
format: uuid
@@ -85555,44 +183181,126 @@ components:
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritableProviderNetwork:
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
provider:
type: string
format: uuid
name:
type: string
+ minLength: 1
maxLength: 100
slug:
type: string
@@ -85606,40 +183314,258 @@ components:
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritableRack:
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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: Mixin to add `status` choice field to model serializers.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
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
@@ -85649,6 +183575,10 @@ components:
site:
type: string
format: uuid
+ location:
+ type: string
+ format: uuid
+ nullable: true
group:
type: string
format: uuid
@@ -85659,7 +183589,7 @@ components:
format: uuid
nullable: true
status:
- $ref: '#/components/schemas/WritableRackStatusEnum'
+ $ref: '#/components/schemas/RackStatusChoices'
role:
type: string
format: uuid
@@ -85715,111 +183645,126 @@ components:
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- device_count:
- type: integer
- readOnly: true
- powerfeed_count:
- type: integer
- readOnly: true
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritableRackGroup:
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
- name:
- type: string
- maxLength: 100
- slug:
- type: string
- maxLength: 100
- pattern: ^[-a-zA-Z0-9_]+$
- site:
- type: string
- format: uuid
- parent:
- type: string
- format: uuid
- nullable: true
- description:
- type: string
- maxLength: 200
- rack_count:
- type: integer
- readOnly: true
- _depth:
- type: integer
- readOnly: true
- title: ' depth'
- custom_fields:
- type: object
- additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- computed_fields:
- type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritableRackReservation:
- type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
- properties:
- id:
- type: string
- format: uuid
- readOnly: true
- url:
- type: string
- format: uri
- readOnly: true
rack:
type: string
format: uuid
units:
type: object
additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
user:
type: string
format: uuid
@@ -85829,40 +183774,131 @@ components:
nullable: true
description:
type: string
+ minLength: 1
maxLength: 200
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritableRearPort:
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
device:
type: string
format: uuid
name:
type: string
+ minLength: 1
maxLength: 64
label:
type: string
@@ -85877,52 +183913,129 @@ components:
description:
type: string
maxLength: 200
- cable:
- allOf:
- - $ref: '#/components/schemas/NestedCable'
- readOnly: true
- cable_peer:
- type: object
- additionalProperties: {}
- nullable: true
- readOnly: true
- cable_peer_type:
- type: string
- nullable: true
- readOnly: true
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritableRearPortTemplate:
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
device_type:
type: string
format: uuid
name:
type: string
+ minLength: 1
maxLength: 64
label:
type: string
@@ -85940,25 +184053,119 @@ components:
custom_fields:
type: object
additionalProperties: {}
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritableRegion:
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
name:
type: string
+ minLength: 1
maxLength: 100
slug:
type: string
@@ -85971,39 +184178,118 @@ components:
description:
type: string
maxLength: 200
- site_count:
- type: integer
- readOnly: true
- _depth:
- type: integer
- readOnly: true
- title: ' depth'
custom_fields:
type: object
additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritableRelationshipAssociation:
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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:
- id:
- type: string
- format: uuid
- readOnly: true
relationship:
type: string
format: uuid
@@ -86017,21 +184303,16 @@ components:
destination_id:
type: string
format: uuid
- PatchedWritableRouteTarget:
+ PatchedWritableRouteTargetRequest:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
name:
type: string
+ minLength: 1
description: Route target value (formatted in accordance with RFC 4360)
maxLength: 21
tenant:
@@ -86044,38 +184325,117 @@ components:
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritableSecretsGroupAssociation:
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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:
- id:
- type: string
- format: uuid
- readOnly: true
- url:
- type: string
- format: uri
- readOnly: true
group:
type: string
format: uuid
@@ -86086,23 +184446,140 @@ components:
secret:
type: string
format: uuid
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritableService:
+ PatchedWritableServiceObjectGroupRequest:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: ServiceObjectGroup Serializer.
properties:
- id:
+ 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
- format: uuid
- readOnly: true
- url:
+ maxLength: 200
+ name:
type: string
- format: uri
- readOnly: true
+ 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
@@ -86113,6 +184590,7 @@ components:
nullable: true
name:
type: string
+ minLength: 1
maxLength: 100
ports:
type: array
@@ -86135,47 +184613,130 @@ components:
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritableSite:
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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: Mixin to add `status` choice field to model serializers.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
name:
type: string
+ minLength: 1
maxLength: 100
slug:
type: string
maxLength: 100
pattern: ^[-a-zA-Z0-9_]+$
status:
- $ref: '#/components/schemas/WritableSiteStatusEnum'
+ $ref: '#/components/schemas/LocationStatusChoices'
region:
type: string
format: uuid
@@ -86235,58 +184796,120 @@ components:
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- circuit_count:
- type: integer
- readOnly: true
- device_count:
- type: integer
- readOnly: true
- prefix_count:
- type: integer
- readOnly: true
- rack_count:
- type: integer
- readOnly: true
- virtualmachine_count:
- type: integer
- readOnly: true
- vlan_count:
- type: integer
- readOnly: true
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritableSoftwareImageLCM:
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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:
- id:
- type: string
- format: uuid
- readOnly: true
- url:
- type: string
- format: uri
- readOnly: true
image_file_name:
type: string
+ minLength: 1
maxLength: 100
software:
type: string
@@ -86322,28 +184945,120 @@ components:
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritableSoftwareLCM:
+ $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:
- id:
- type: string
- format: uuid
- readOnly: true
- url:
- type: string
- format: uri
- readOnly: true
device_platform:
type: string
format: uuid
version:
type: string
+ minLength: 1
maxLength: 50
alias:
type: string
@@ -86377,26 +185092,248 @@ components:
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritableTenant:
+ $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: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
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
@@ -86414,125 +185351,249 @@ components:
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- circuit_count:
- type: integer
- readOnly: true
- device_count:
- type: integer
- readOnly: true
- ipaddress_count:
- type: integer
- readOnly: true
- prefix_count:
- type: integer
- readOnly: true
- rack_count:
- type: integer
- readOnly: true
- site_count:
- type: integer
- readOnly: true
- virtualmachine_count:
- type: integer
- readOnly: true
- vlan_count:
- type: integer
- readOnly: true
- vrf_count:
- type: integer
- readOnly: true
- cluster_count:
- type: integer
- readOnly: true
- computed_fields:
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritableTenantGroup:
- type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
- properties:
- id:
- type: string
- format: uuid
- readOnly: true
- url:
- type: string
- format: uri
- readOnly: true
- name:
- type: string
- maxLength: 100
- slug:
- type: string
- maxLength: 100
- pattern: ^[-a-zA-Z0-9_]+$
- parent:
- type: string
- format: uuid
- nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
description:
type: string
maxLength: 200
- tenant_count:
- type: integer
- readOnly: true
- _depth:
- type: integer
- readOnly: true
- title: ' depth'
- custom_fields:
- type: object
- additionalProperties: {}
- created:
+ name:
type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- computed_fields:
- type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritableUser:
+ 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:
- id:
- type: string
- format: uuid
- readOnly: true
- url:
- type: string
- format: uri
- readOnly: true
username:
type: string
+ minLength: 1
description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
pattern: ^[\w.@+-]+$
@@ -86540,6 +185601,7 @@ components:
password:
type: string
writeOnly: true
+ minLength: 1
maxLength: 128
first_name:
type: string
@@ -86570,26 +185632,153 @@ components:
type: integer
description: The groups this user belongs to. A user will get all permissions
granted to each of their groups.
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritableVLAN:
+ PatchedWritableVLANGroupRequest:
type: object
- description: Mixin to add `status` choice field to model serializers.
+ description: |-
+ Base class to use for serializers 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:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ site:
type: string
format: uuid
- readOnly: true
- url:
+ nullable: true
+ location:
type: string
- format: uri
- readOnly: true
+ 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
@@ -86601,13 +185790,14 @@ components:
title: ID
name:
type: string
+ minLength: 1
maxLength: 64
tenant:
type: string
format: uuid
nullable: true
status:
- $ref: '#/components/schemas/WritableVLANStatusEnum'
+ $ref: '#/components/schemas/VLANStatusChoices'
role:
type: string
format: uuid
@@ -86618,100 +185808,142 @@ components:
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- prefix_count:
- type: integer
- readOnly: true
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritableVLANGroup:
- type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
- properties:
- id:
- type: string
- format: uuid
- readOnly: true
- url:
- type: string
- format: uri
- readOnly: true
- name:
- type: string
- maxLength: 100
- slug:
- type: string
- maxLength: 100
- pattern: ^[-a-zA-Z0-9_]+$
- site:
- type: string
- format: uuid
- nullable: true
- description:
- type: string
- maxLength: 200
- vlan_count:
- type: integer
- readOnly: true
- custom_fields:
- type: object
- additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- computed_fields:
- type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritableVMInterface:
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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: |-
- 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)
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
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
@@ -86741,26 +185973,123 @@ components:
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritableVRF:
+ $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: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
name:
type: string
+ minLength: 1
maxLength: 100
rd:
type: string
@@ -86792,44 +186121,117 @@ components:
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- ipaddress_count:
- type: integer
- readOnly: true
- prefix_count:
- type: integer
- readOnly: true
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritableValidatedSoftwareLCM:
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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:
- id:
- type: string
- format: uuid
- readOnly: true
- url:
- type: string
- format: uri
- readOnly: true
software:
type: string
format: uuid
@@ -86871,35 +186273,126 @@ components:
preferred:
type: boolean
title: Preferred Version
- valid:
- type: string
- readOnly: true
custom_fields:
type: object
additionalProperties: {}
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritableVirtualChassis:
+ $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: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
name:
type: string
+ minLength: 1
maxLength: 64
domain:
type: string
@@ -86911,42 +186404,126 @@ components:
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- member_count:
- type: integer
- readOnly: true
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- PatchedWritableVirtualMachineWithConfigContext:
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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: Mixin to add `status` choice field to model serializers.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
name:
type: string
+ minLength: 1
maxLength: 64
status:
- $ref: '#/components/schemas/WritableVirtualMachineWithConfigContextStatusEnum'
- site:
- allOf:
- - $ref: '#/components/schemas/NestedSite'
- readOnly: true
+ $ref: '#/components/schemas/VirtualMachineStatusChoices'
cluster:
type: string
format: uuid
@@ -86962,10 +186539,6 @@ components:
type: string
format: uuid
nullable: true
- primary_ip:
- allOf:
- - $ref: '#/components/schemas/NestedIPAddress'
- readOnly: true
primary_ip4:
type: string
format: uuid
@@ -87007,40 +186580,635 @@ components:
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- config_context:
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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: {}
- readOnly: true
- created:
+ interfaces:
+ type: array
+ items:
+ $ref: '#/components/schemas/NestedInterfaceRequest'
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
+ description:
type: string
- format: date
- readOnly: true
- last_updated:
+ maxLength: 200
+ name:
type: string
- format: date-time
- readOnly: true
+ 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
- type: string
Platform:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
@@ -87077,21 +187245,23 @@ components:
virtualmachine_count:
type: integer
readOnly: true
- custom_fields:
- type: object
- additionalProperties: {}
created:
type: string
format: date
readOnly: true
+ nullable: true
last_updated:
type: string
format: date-time
readOnly: true
- display:
+ nullable: true
+ notes_url:
type: string
+ format: uri
readOnly: true
- description: Human friendly display value
+ custom_fields:
+ type: object
+ additionalProperties: {}
required:
- created
- device_count
@@ -87099,13 +187269,1565 @@ components:
- 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
@@ -87134,15 +188856,21 @@ components:
- urm-p4
- urm-p8
- splice
- type: string
PowerFeed:
type: object
- description: Mixin to add `status` choice field to model serializers.
+ description: |-
+ Base class to use for serializers 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
@@ -87262,25 +188990,27 @@ components:
type: boolean
nullable: true
readOnly: true
- tags:
- type: array
- items:
- $ref: '#/components/schemas/TagSerializerField'
- custom_fields:
- type: object
- additionalProperties: {}
created:
type: string
format: date
readOnly: true
+ nullable: true
last_updated:
type: string
format: date-time
readOnly: true
- display:
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
type: string
+ format: uri
readOnly: true
- description: Human friendly display value
+ custom_fields:
+ type: object
+ additionalProperties: {}
required:
- cable
- cable_peer
@@ -87293,23 +189023,37 @@ components:
- id
- last_updated
- name
+ - notes_url
- power_panel
- status
- url
+ PowerFeedStatusChoices:
+ type: string
+ enum:
+ - active
+ - failed
+ - offline
+ - planned
PowerFeedTypeChoices:
+ type: string
enum:
- primary
- redundant
- type: string
PowerOutlet:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
@@ -87534,17 +189278,27 @@ components:
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: {}
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- cable
- cable_peer
@@ -87552,20 +189306,29 @@ components:
- connected_endpoint
- connected_endpoint_reachable
- connected_endpoint_type
+ - created
- device
- display
- id
+ - last_updated
- name
+ - notes_url
- url
PowerOutletTemplate:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
@@ -87764,20 +189527,29 @@ components:
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: {}
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
+ - created
- device_type
- display
- id
+ - last_updated
- name
- url
PowerOutletTypeChoices:
+ type: string
enum:
- iec-60320-c5
- iec-60320-c7
@@ -87857,22 +189629,31 @@ components:
- usb-micro-b
- usb-c
- hdot-cx
- type: string
PowerPanel:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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'
@@ -87880,36 +189661,55 @@ components:
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: {}
- powerfeed_count:
- type: integer
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
+ - created
- display
- id
+ - last_updated
- name
+ - notes_url
- powerfeed_count
- site
- url
PowerPort:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
@@ -88141,43 +189941,57 @@ components:
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: {}
- computed_fields:
- type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- cable
- cable_peer
- cable_peer_type
- - computed_fields
- connected_endpoint
- connected_endpoint_reachable
- connected_endpoint_type
+ - created
- device
- display
- id
+ - last_updated
- name
+ - notes_url
- url
PowerPortTemplate:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
@@ -88383,20 +190197,29 @@ components:
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: {}
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
+ - created
- device_type
- display
- id
+ - last_updated
- name
- url
PowerPortTypeChoices:
+ type: string
enum:
- iec-60320-c6
- iec-60320-c8
@@ -88482,15 +190305,21 @@ components:
- usb-micro-b
- usb-3-b
- usb-3-micro-b
- type: string
Prefix:
type: object
- description: Mixin to add `status` choice field to model serializers.
+ description: |-
+ Base class to use for serializers 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
@@ -88515,6 +190344,10 @@ components:
allOf:
- $ref: '#/components/schemas/NestedSite'
nullable: true
+ location:
+ allOf:
+ - $ref: '#/components/schemas/NestedLocation'
+ nullable: true
vrf:
allOf:
- $ref: '#/components/schemas/NestedVRF'
@@ -88557,46 +190390,57 @@ components:
description:
type: string
maxLength: 200
- tags:
- type: array
- items:
- $ref: '#/components/schemas/TagSerializerField'
- custom_fields:
- type: object
- additionalProperties: {}
created:
type: string
format: date
readOnly: true
+ nullable: true
last_updated:
type: string
format: date-time
readOnly: true
- display:
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
type: string
+ format: uri
readOnly: true
- description: Human friendly display value
+ custom_fields:
+ type: object
+ additionalProperties: {}
required:
- created
- display
- family
- id
- last_updated
+ - notes_url
- prefix
- status
- url
- PrefixLength:
+ 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
- type: string
ProvidedContentsEnum:
enum:
- extras.configcontext
@@ -88610,13 +190454,19 @@ components:
type: string
Provider:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
@@ -88649,28 +190499,30 @@ components:
type: string
comments:
type: string
- tags:
- type: array
- items:
- $ref: '#/components/schemas/TagSerializerField'
- custom_fields:
- type: object
- additionalProperties: {}
+ circuit_count:
+ type: integer
+ readOnly: true
created:
type: string
format: date
readOnly: true
+ nullable: true
last_updated:
type: string
format: date-time
readOnly: true
- circuit_count:
- type: integer
- readOnly: true
- display:
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
type: string
+ format: uri
readOnly: true
- description: Human friendly display value
+ custom_fields:
+ type: object
+ additionalProperties: {}
required:
- circuit_count
- created
@@ -88678,11 +190530,20 @@ components:
- 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
@@ -88713,23 +190574,174 @@ components:
type: array
items:
$ref: '#/components/schemas/TagSerializerField'
- display:
+ created:
type: string
+ format: date
readOnly: true
- description: Human friendly display value
+ 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: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
@@ -88748,42 +190760,199 @@ components:
maxLength: 200
comments:
type: string
- tags:
- type: array
- items:
- $ref: '#/components/schemas/TagSerializerField'
- custom_fields:
- type: object
- additionalProperties: {}
created:
type: string
format: date
readOnly: true
+ nullable: true
last_updated:
type: string
format: date-time
readOnly: true
- display:
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
type: string
+ format: uri
readOnly: true
- description: Human friendly display value
+ 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: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
@@ -88805,21 +190974,23 @@ components:
aggregate_count:
type: integer
readOnly: true
- custom_fields:
- type: object
- additionalProperties: {}
created:
type: string
format: date
readOnly: true
+ nullable: true
last_updated:
type: string
format: date-time
readOnly: true
- display:
+ nullable: true
+ notes_url:
type: string
+ format: uri
readOnly: true
- description: Human friendly display value
+ custom_fields:
+ type: object
+ additionalProperties: {}
required:
- aggregate_count
- created
@@ -88827,15 +190998,153 @@ components:
- 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: Mixin to add `status` choice field to model serializers.
+ description: |-
+ Base class to use for serializers 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
@@ -88850,6 +191159,10 @@ components:
maxLength: 50
site:
$ref: '#/components/schemas/NestedSite'
+ location:
+ allOf:
+ - $ref: '#/components/schemas/NestedLocation'
+ nullable: true
group:
allOf:
- $ref: '#/components/schemas/NestedRackGroup'
@@ -88963,31 +191276,33 @@ components:
- Inches
comments:
type: string
- tags:
- type: array
- items:
- $ref: '#/components/schemas/TagSerializerField'
- custom_fields:
- type: object
- additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
device_count:
type: integer
readOnly: true
powerfeed_count:
type: integer
readOnly: true
- display:
+ created:
type: string
+ format: date
readOnly: true
- description: Human friendly display value
+ 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
@@ -88995,19 +191310,26 @@ components:
- id
- last_updated
- name
+ - notes_url
- powerfeed_count
- site
- status
- url
RackGroup:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
@@ -89021,6 +191343,10 @@ components:
pattern: ^[-a-zA-Z0-9_]+$
site:
$ref: '#/components/schemas/NestedSite'
+ location:
+ allOf:
+ - $ref: '#/components/schemas/NestedLocation'
+ nullable: true
parent:
allOf:
- $ref: '#/components/schemas/NestedRackGroup'
@@ -89035,21 +191361,23 @@ components:
type: integer
readOnly: true
title: ' depth'
- custom_fields:
- type: object
- additionalProperties: {}
created:
type: string
format: date
readOnly: true
+ nullable: true
last_updated:
type: string
format: date-time
readOnly: true
- display:
+ nullable: true
+ notes_url:
type: string
+ format: uri
readOnly: true
- description: Human friendly display value
+ custom_fields:
+ type: object
+ additionalProperties: {}
required:
- _depth
- created
@@ -89057,18 +191385,25 @@ components:
- id
- last_updated
- name
+ - notes_url
- rack_count
- site
- url
RackReservation:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
@@ -89078,10 +191413,6 @@ components:
units:
type: object
additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
user:
$ref: '#/components/schemas/NestedUser'
tenant:
@@ -89091,35 +191422,53 @@ components:
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: {}
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- created
- description
- display
- id
+ - last_updated
+ - notes_url
- rack
- units
- url
- user
RackRole:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
@@ -89141,37 +191490,179 @@ components:
rack_count:
type: integer
readOnly: true
- custom_fields:
- type: object
- additionalProperties: {}
created:
type: string
format: date
readOnly: true
+ nullable: true
last_updated:
type: string
format: date-time
readOnly: true
- display:
+ nullable: true
+ notes_url:
type: string
+ format: uri
readOnly: true
- description: Human friendly display value
+ 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
- type: string
RackUnit:
type: object
description: A rack unit is an abstraction formed by the set (rack, position,
@@ -89212,13 +191703,19 @@ components:
- occupied
RearPort:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
@@ -89315,36 +191812,55 @@ components:
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: {}
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- cable
- cable_peer
- cable_peer_type
+ - created
- device
- display
- id
+ - last_updated
- name
+ - notes_url
- type
- url
RearPortTemplate:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
@@ -89428,29 +191944,43 @@ components:
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: {}
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
+ - created
- device_type
- display
- id
+ - last_updated
- name
- type
- url
Region:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
@@ -89476,21 +192006,23 @@ components:
type: integer
readOnly: true
title: ' depth'
- custom_fields:
- type: object
- additionalProperties: {}
created:
type: string
format: date
readOnly: true
+ nullable: true
last_updated:
type: string
format: date-time
readOnly: true
- display:
+ nullable: true
+ notes_url:
type: string
+ format: uri
readOnly: true
- description: Human friendly display value
+ custom_fields:
+ type: object
+ additionalProperties: {}
required:
- _depth
- created
@@ -89498,12 +192030,17 @@ components:
- 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
@@ -89537,14 +192074,12 @@ components:
type: string
format: date
readOnly: true
+ nullable: true
last_updated:
type: string
format: date-time
readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
+ nullable: true
required:
- content_type
- created
@@ -89556,23 +192091,67 @@ components:
- 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: Internal relationship name
+ 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:
@@ -89582,6 +192161,12 @@ components:
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:
@@ -89597,8 +192182,8 @@ components:
type: object
additionalProperties: {}
nullable: true
- description: Queryset filter matching the applicable source objects of the
- selected type
+ description: Filterset filter matching the applicable source objects of
+ the selected type
destination_type:
type: string
destination_label:
@@ -89614,21 +192199,50 @@ components:
type: object
additionalProperties: {}
nullable: true
- description: Queryset filter matching the applicable destination objects
+ 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:
@@ -89644,10 +192258,80 @@ components:
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
@@ -89656,15 +192340,26 @@ components:
- many-to-many
- symmetric-many-to-many
type: string
+ RequiredOnEnum:
+ enum:
+ - source
+ - destination
+ type: string
Role:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
@@ -89689,31 +192384,35 @@ components:
vlan_count:
type: integer
readOnly: true
- custom_fields:
- type: object
- additionalProperties: {}
created:
type: string
format: date
readOnly: true
+ nullable: true
last_updated:
type: string
format: date-time
readOnly: true
- display:
+ nullable: true
+ notes_url:
type: string
+ format: uri
readOnly: true
- description: Human friendly display value
+ 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
@@ -89723,16 +192422,151 @@ components:
- hsrp
- glbp
- carp
- type: string
+ 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: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
@@ -89748,39 +192582,54 @@ components:
description:
type: string
maxLength: 200
- tags:
- type: array
- items:
- $ref: '#/components/schemas/TagSerializerField'
- custom_fields:
- type: object
- additionalProperties: {}
created:
type: string
format: date
readOnly: true
+ nullable: true
last_updated:
type: string
format: date-time
readOnly: true
- display:
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
type: string
+ format: uri
readOnly: true
- description: Human friendly display value
+ 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
@@ -89804,7 +192653,7 @@ components:
"proj.tasks.import_contacts")'
maxLength: 200
interval:
- $ref: '#/components/schemas/IntervalEnum'
+ $ref: '#/components/schemas/JobExecutionTypeIntervalChoices'
queue:
type: string
nullable: true
@@ -89820,6 +192669,7 @@ components:
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.
@@ -89847,12 +192697,19 @@ components:
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
@@ -89871,6 +192728,10 @@ components:
type: string
format: uuid
readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
url:
type: string
format: uri
@@ -89891,33 +192752,171 @@ components:
parameters:
type: object
additionalProperties: {}
- 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
- display:
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
type: string
+ format: uri
readOnly: true
- description: Human friendly display value
+ 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
@@ -89934,6 +192933,10 @@ components:
type: string
format: uuid
readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
url:
type: string
format: uri
@@ -89953,27 +192956,30 @@ components:
items:
$ref: '#/components/schemas/NestedSecretsGroupAssociation'
readOnly: true
- custom_fields:
- type: object
- additionalProperties: {}
created:
type: string
format: date
readOnly: true
+ nullable: true
last_updated:
type: string
format: date-time
readOnly: true
- display:
+ nullable: true
+ notes_url:
type: string
+ format: uri
readOnly: true
- description: Human friendly display value
+ custom_fields:
+ type: object
+ additionalProperties: {}
required:
- created
- display
- id
- last_updated
- name
+ - notes_url
- secrets
- url
SecretsGroupAssociation:
@@ -89984,6 +192990,10 @@ components:
type: string
format: uuid
readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
url:
type: string
format: uri
@@ -89996,10 +193006,6 @@ components:
$ref: '#/components/schemas/SecretTypeEnum'
secret:
$ref: '#/components/schemas/NestedSecret'
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- access_type
- display
@@ -90008,15 +193014,144 @@ components:
- 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: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
@@ -90056,6 +193191,10 @@ components:
items:
type: object
properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
id:
type: string
format: uuid
@@ -90069,10 +193208,6 @@ components:
readOnly: true
address:
type: string
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- address
- display
@@ -90082,41 +193217,557 @@ components:
description:
type: string
maxLength: 200
- tags:
- type: array
- items:
- $ref: '#/components/schemas/TagSerializerField'
- custom_fields:
- type: object
- additionalProperties: {}
created:
type: string
format: date
readOnly: true
+ nullable: true
last_updated:
type: string
format: date-time
readOnly: true
- display:
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
type: string
+ format: uri
readOnly: true
- description: Human friendly display value
+ custom_fields:
+ type: object
+ additionalProperties: {}
required:
- created
- display
- id
- last_updated
- name
+ - notes_url
- ports
- url
- Site:
+ ServiceObject:
type: object
- description: Mixin to add `status` choice field to model serializers.
+ 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
@@ -90203,21 +193854,6 @@ components:
maxLength: 254
comments:
type: string
- tags:
- type: array
- items:
- $ref: '#/components/schemas/TagSerializerField'
- custom_fields:
- type: object
- additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
circuit_count:
type: integer
readOnly: true
@@ -90236,10 +193872,27 @@ components:
vlan_count:
type: integer
readOnly: true
- display:
+ created:
type: string
+ format: date
readOnly: true
- description: Human friendly display value
+ 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
@@ -90248,6 +193901,7 @@ components:
- id
- last_updated
- name
+ - notes_url
- prefix_count
- rack_count
- status
@@ -90258,6 +193912,10 @@ components:
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
@@ -90302,20 +193960,32 @@ components:
type: array
items:
$ref: '#/components/schemas/TagSerializerField'
- display:
+ created:
type: string
+ format: date
readOnly: true
- description: Human friendly display value
+ 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
@@ -90351,6 +194021,10 @@ components:
items:
type: object
properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
id:
type: string
format: uuid
@@ -90386,10 +194060,6 @@ components:
maxLength: 256
default_image:
type: boolean
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- display
- id
@@ -90406,14 +194076,22 @@ components:
type: array
items:
$ref: '#/components/schemas/TagSerializerField'
- display:
+ created:
type: string
+ format: date
readOnly: true
- description: Human friendly display value
+ nullable: true
+ last_updated:
+ type: string
+ format: date-time
+ readOnly: true
+ nullable: true
required:
+ - created
- device_platform
- display
- id
+ - last_updated
- url
- version
Status:
@@ -90424,6 +194102,10 @@ components:
type: string
format: uuid
readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
url:
type: string
format: uri
@@ -90443,21 +194125,23 @@ components:
type: string
pattern: ^[0-9a-f]{6}$
maxLength: 6
- custom_fields:
- type: object
- additionalProperties: {}
created:
type: string
format: date
readOnly: true
+ nullable: true
last_updated:
type: string
format: date-time
readOnly: true
- display:
+ nullable: true
+ notes_url:
type: string
+ format: uri
readOnly: true
- description: Human friendly display value
+ custom_fields:
+ type: object
+ additionalProperties: {}
required:
- content_types
- created
@@ -90465,24 +194149,181 @@ components:
- 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
- type: string
SupplyEnum:
+ type: string
enum:
- ac
- dc
- type: string
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
@@ -90496,31 +194337,65 @@ components:
maxLength: 100
slug:
type: string
+ pattern: ^[-\w]+$
maxLength: 100
- pattern: ^[-a-zA-Z0-9_]+$
color:
type: string
pattern: ^[0-9a-f]{6}$
maxLength: 6
- display:
+ created:
type: string
+ format: date
readOnly: true
- description: Human friendly display value
+ 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: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
@@ -90530,8 +194405,8 @@ components:
maxLength: 100
slug:
type: string
+ pattern: ^[-\w]+$
maxLength: 100
- pattern: ^[-a-zA-Z0-9_]+$
color:
type: string
pattern: ^[0-9a-f]{6}$
@@ -90546,21 +194421,23 @@ components:
type: array
items:
type: string
- custom_fields:
- type: object
- additionalProperties: {}
created:
type: string
format: date
readOnly: true
+ nullable: true
last_updated:
type: string
format: date-time
readOnly: true
- display:
+ nullable: true
+ notes_url:
type: string
+ format: uri
readOnly: true
- description: Human friendly display value
+ custom_fields:
+ type: object
+ additionalProperties: {}
required:
- content_types
- created
@@ -90568,18 +194445,163 @@ components:
- 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: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
@@ -90598,21 +194620,6 @@ components:
maxLength: 200
comments:
type: string
- tags:
- type: array
- items:
- $ref: '#/components/schemas/TagSerializerField'
- custom_fields:
- type: object
- additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
circuit_count:
type: integer
readOnly: true
@@ -90643,10 +194650,27 @@ components:
cluster_count:
type: integer
readOnly: true
- display:
+ created:
type: string
+ format: date
readOnly: true
- description: Human friendly display value
+ 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
@@ -90657,6 +194681,7 @@ components:
- ipaddress_count
- last_updated
- name
+ - notes_url
- prefix_count
- rack_count
- site_count
@@ -90666,13 +194691,19 @@ components:
- vrf_count
TenantGroup:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
@@ -90698,21 +194729,23 @@ components:
type: integer
readOnly: true
title: ' depth'
- custom_fields:
- type: object
- additionalProperties: {}
created:
type: string
format: date
readOnly: true
+ nullable: true
last_updated:
type: string
format: date-time
readOnly: true
- display:
+ nullable: true
+ notes_url:
type: string
+ format: uri
readOnly: true
- description: Human friendly display value
+ custom_fields:
+ type: object
+ additionalProperties: {}
required:
- _depth
- created
@@ -90720,6 +194753,7 @@ components:
- id
- last_updated
- name
+ - notes_url
- tenant_count
- url
TermSideEnum:
@@ -90768,12 +194802,36 @@ components:
- 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
@@ -90788,10 +194846,6 @@ components:
only.
pattern: ^[\w.@+-]+$
maxLength: 150
- password:
- type: string
- writeOnly: true
- maxLength: 128
first_name:
type: string
maxLength: 150
@@ -90820,6 +194874,10 @@ components:
items:
type: object
properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
id:
type: integer
readOnly: true
@@ -90830,33 +194888,380 @@ components:
name:
type: string
maxLength: 150
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- display
- id
- name
- url
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- display
- id
- - password
- url
- username
- VLAN:
+ UserObject:
type: object
- description: Mixin to add `status` choice field to model serializers.
+ 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
@@ -90865,6 +195270,10 @@ components:
allOf:
- $ref: '#/components/schemas/NestedSite'
nullable: true
+ location:
+ allOf:
+ - $ref: '#/components/schemas/NestedLocation'
+ nullable: true
group:
allOf:
- $ref: '#/components/schemas/NestedVLANGroup'
@@ -90903,47 +195312,56 @@ components:
description:
type: string
maxLength: 200
- tags:
- type: array
- items:
- $ref: '#/components/schemas/TagSerializerField'
- custom_fields:
- type: object
- additionalProperties: {}
+ prefix_count:
+ type: integer
+ readOnly: true
created:
type: string
format: date
readOnly: true
+ nullable: true
last_updated:
type: string
format: date-time
readOnly: true
- prefix_count:
- type: integer
- readOnly: true
- display:
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
type: string
+ format: uri
readOnly: true
- description: Human friendly display value
+ custom_fields:
+ type: object
+ additionalProperties: {}
required:
- created
- display
- id
- last_updated
- name
+ - notes_url
- prefix_count
- status
- url
- vid
VLANGroup:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
@@ -90959,45 +195377,63 @@ components:
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
- custom_fields:
- type: object
- additionalProperties: {}
created:
type: string
format: date
readOnly: true
+ nullable: true
last_updated:
type: string
format: date-time
readOnly: true
- display:
+ nullable: true
+ notes_url:
type: string
+ format: uri
readOnly: true
- description: Human friendly display value
+ custom_fields:
+ type: object
+ additionalProperties: {}
required:
- created
- display
- id
- last_updated
- name
+ - notes_url
- url
- vlan_count
- VMInterface:
+ VLANStatusChoices:
+ type: string
+ enum:
+ - active
+ - deprecated
+ - reserved
+ VMInterfaceSerializerVersion12:
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)
+ Base class to use for serializers 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
@@ -91009,6 +195445,14 @@ components:
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
@@ -91045,6 +195489,10 @@ components:
items:
type: object
properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
id:
type: string
format: uuid
@@ -91061,10 +195509,6 @@ components:
name:
type: string
maxLength: 64
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- display
- id
@@ -91075,25 +195519,35 @@ components:
type: array
items:
$ref: '#/components/schemas/TagSerializerField'
- display:
+ notes_url:
type: string
+ format: uri
readOnly: true
- description: Human friendly display value
+ custom_fields:
+ type: object
+ additionalProperties: {}
required:
- display
- id
- name
+ - notes_url
- url
- virtual_machine
VRF:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
@@ -91123,6 +195577,10 @@ components:
items:
type: object
properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
id:
type: string
format: uuid
@@ -91136,10 +195594,6 @@ components:
description: Route target value (formatted in accordance with RFC
4360)
maxLength: 21
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- display
- id
@@ -91150,6 +195604,10 @@ components:
items:
type: object
properties:
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
id:
type: string
format: uuid
@@ -91163,40 +195621,38 @@ components:
description: Route target value (formatted in accordance with RFC
4360)
maxLength: 21
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- display
- id
- name
- url
- tags:
- type: array
- items:
- $ref: '#/components/schemas/TagSerializerField'
- custom_fields:
- type: object
- additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
ipaddress_count:
type: integer
readOnly: true
prefix_count:
type: integer
readOnly: true
- display:
+ created:
type: string
+ format: date
readOnly: true
- description: Human friendly display value
+ 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
@@ -91204,12 +195660,17 @@ components:
- 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
@@ -91267,26 +195728,40 @@ components:
type: array
items:
$ref: '#/components/schemas/TagSerializerField'
- display:
+ created:
type: string
+ format: date
readOnly: true
- description: Human friendly display value
+ 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: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
@@ -91301,34 +195776,63 @@ components:
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: {}
- member_count:
- type: integer
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
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: Mixin to add `status` choice field to model serializers.
+ description: |-
+ Base class to use for serializers 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
@@ -91361,6 +195865,11 @@ components:
allOf:
- $ref: '#/components/schemas/NestedSite'
readOnly: true
+ location:
+ allOf:
+ - $ref: '#/components/schemas/NestedLocation'
+ readOnly: true
+ nullable: true
cluster:
$ref: '#/components/schemas/NestedCluster'
role:
@@ -91414,13 +195923,6 @@ components:
allOf:
- $ref: '#/components/schemas/NestedConfigContextSchema'
nullable: true
- tags:
- type: array
- items:
- $ref: '#/components/schemas/TagSerializerField'
- custom_fields:
- type: object
- additionalProperties: {}
config_context:
type: object
additionalProperties: {}
@@ -91429,14 +195931,23 @@ components:
type: string
format: date
readOnly: true
+ nullable: true
last_updated:
type: string
format: date-time
readOnly: true
- display:
+ nullable: true
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSerializerField'
+ notes_url:
type: string
+ format: uri
readOnly: true
- description: Human friendly display value
+ custom_fields:
+ type: object
+ additionalProperties: {}
required:
- cluster
- config_context
@@ -91444,7 +195955,9 @@ components:
- display
- id
- last_updated
+ - location
- name
+ - notes_url
- primary_ip
- site
- status
@@ -91497,15 +196010,145 @@ components:
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: |-
@@ -91516,6 +196159,10 @@ components:
type: string
format: uuid
readOnly: true
+ display:
+ type: string
+ readOnly: true
+ description: Human friendly display value
url:
type: string
format: uri
@@ -91575,43 +196222,417 @@ components:
description: The specific CA certificate file to use for SSL verification.
Leave blank to use the system defaults.
maxLength: 4096
- display:
+ 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
- description: Human friendly display value
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
- type: integer
- WritableAggregate:
+ WritableAddressFamilyRequest:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: REST API serializer for AddressFamily records.
properties:
- id:
+ afi_safi:
+ $ref: '#/components/schemas/AfiSafiEnum'
+ routing_instance:
type: string
format: uuid
- readOnly: true
- url:
+ title: BGP Routing Instance
+ vrf:
type: string
- format: uri
- readOnly: true
- family:
- allOf:
- - $ref: '#/components/schemas/FamilyEnum'
- readOnly: true
+ 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
@@ -91629,74 +196650,350 @@ components:
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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:
- - computed_fields
- - created
- - display
- - family
- - id
- - last_updated
- prefix
- rir
- - url
- WritableCable:
+ WritableAutonomousSystemRequest:
type: object
- description: Mixin to add `status` choice field to model serializers.
+ description: REST API serializer for AutonomousSystem records.
properties:
- id:
+ 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
- readOnly: true
- url:
+ 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
- readOnly: true
+ 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_a:
- type: object
- additionalProperties: {}
- nullable: true
- readOnly: true
termination_b_type:
type: string
termination_b_id:
type: string
format: uuid
- termination_b:
- type: object
- additionalProperties: {}
- nullable: true
- readOnly: true
type:
oneOf:
- $ref: '#/components/schemas/CableTypeChoices'
- $ref: '#/components/schemas/BlankEnum'
status:
- $ref: '#/components/schemas/WritableCableStatusEnum'
+ $ref: '#/components/schemas/CableStatusChoices'
label:
type: string
maxLength: 100
@@ -91716,50 +197013,129 @@ components:
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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:
- - computed_fields
- - display
- - id
- status
- - termination_a
- termination_a_id
- termination_a_type
- - termination_b
- termination_b_id
- termination_b_type
- - url
- WritableCableStatusEnum:
- type: string
- enum:
- - connected
- - decommissioning
- - planned
- WritableCircuit:
+ WritableCircuitRequest:
type: object
- description: Mixin to add `status` choice field to model serializers.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
cid:
type: string
+ minLength: 1
title: Circuit ID
maxLength: 100
provider:
@@ -91769,7 +197145,7 @@ components:
type: string
format: uuid
status:
- $ref: '#/components/schemas/WritableCircuitStatusEnum'
+ $ref: '#/components/schemas/CircuitStatusChoices'
tenant:
type: string
format: uuid
@@ -91788,75 +197164,130 @@ components:
description:
type: string
maxLength: 200
- termination_a:
- allOf:
- - $ref: '#/components/schemas/CircuitCircuitTermination'
- readOnly: true
- termination_z:
- allOf:
- - $ref: '#/components/schemas/CircuitCircuitTermination'
- readOnly: true
comments:
type: string
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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
- - computed_fields
- - created
- - display
- - id
- - last_updated
- provider
- status
- - termination_a
- - termination_z
- type
- - url
- WritableCircuitStatusEnum:
- type: string
- enum:
- - active
- - decommissioned
- - deprovisioning
- - offline
- - planned
- - provisioning
- WritableCircuitTermination:
+ WritableCircuitTerminationRequest:
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)
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
circuit:
type: string
format: uuid
@@ -91868,6 +197299,10 @@ components:
type: string
format: uuid
nullable: true
+ location:
+ type: string
+ format: uuid
+ nullable: true
provider_network:
type: string
format: uuid
@@ -91896,63 +197331,125 @@ components:
description:
type: string
maxLength: 200
- cable:
- allOf:
- - $ref: '#/components/schemas/NestedCable'
- readOnly: true
- cable_peer:
+ custom_fields:
type: object
additionalProperties: {}
- nullable: true
- readOnly: true
- cable_peer_type:
- type: string
- nullable: true
- readOnly: true
- connected_endpoint:
+ relationships:
type: object
- additionalProperties: {}
- nullable: true
- readOnly: true
- connected_endpoint_type:
- type: string
- nullable: true
- readOnly: true
- connected_endpoint_reachable:
- type: boolean
- nullable: true
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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:
- - cable
- - cable_peer
- - cable_peer_type
- circuit
- - connected_endpoint
- - connected_endpoint_reachable
- - connected_endpoint_type
- - display
- - id
- term_side
- - url
- WritableCluster:
+ WritableClusterRequest:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
name:
type: string
+ minLength: 1
maxLength: 100
type:
type: string
@@ -91969,64 +197466,134 @@ components:
type: string
format: uuid
nullable: true
+ location:
+ type: string
+ format: uuid
+ nullable: true
comments:
type: string
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- device_count:
- type: integer
- readOnly: true
- virtualmachine_count:
- type: integer
- readOnly: true
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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:
- - computed_fields
- - created
- - device_count
- - display
- - id
- - last_updated
- name
- type
- - url
- - virtualmachine_count
- WritableConfigContext:
+ 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:
- id:
- type: string
- format: uuid
- readOnly: true
- url:
- type: string
- format: uri
- readOnly: true
name:
type: string
+ minLength: 1
maxLength: 100
owner_content_type:
type: string
@@ -92035,11 +197602,6 @@ components:
type: string
format: uuid
nullable: true
- owner:
- type: object
- additionalProperties: {}
- nullable: true
- readOnly: true
weight:
type: integer
maximum: 32767
@@ -92064,6 +197626,11 @@ components:
items:
type: string
format: uuid
+ locations:
+ type: array
+ items:
+ type: string
+ format: uuid
roles:
type: array
items:
@@ -92106,45 +197673,22 @@ components:
data:
type: object
additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- - created
- data
- - display
- - id
- - last_updated
- name
- - owner
- - url
- WritableConsolePort:
+ WritableConsolePortRequest:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
device:
type: string
format: uuid
name:
type: string
+ minLength: 1
maxLength: 64
label:
type: string
@@ -92158,78 +197702,132 @@ components:
description:
type: string
maxLength: 200
- cable:
- allOf:
- - $ref: '#/components/schemas/NestedCable'
- readOnly: true
- cable_peer:
- type: object
- additionalProperties: {}
- nullable: true
- readOnly: true
- cable_peer_type:
- type: string
- nullable: true
- readOnly: true
- connected_endpoint:
- type: object
- additionalProperties: {}
- nullable: true
- readOnly: true
- connected_endpoint_type:
- type: string
- nullable: true
- readOnly: true
- connected_endpoint_reachable:
- type: boolean
- nullable: true
- readOnly: true
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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:
- - cable
- - cable_peer
- - cable_peer_type
- - computed_fields
- - connected_endpoint
- - connected_endpoint_reachable
- - connected_endpoint_type
- device
- - display
- - id
- name
- - url
- WritableConsolePortTemplate:
+ WritableConsolePortTemplateRequest:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
device_type:
type: string
format: uuid
name:
type: string
+ minLength: 1
maxLength: 64
label:
type: string
@@ -92245,39 +197843,125 @@ components:
custom_fields:
type: object
additionalProperties: {}
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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:
- - computed_fields
- device_type
- - display
- - id
- name
- - url
- WritableConsoleServerPort:
+ WritableConsoleServerPortRequest:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
device:
type: string
format: uuid
name:
type: string
+ minLength: 1
maxLength: 64
label:
type: string
@@ -92291,78 +197975,132 @@ components:
description:
type: string
maxLength: 200
- cable:
- allOf:
- - $ref: '#/components/schemas/NestedCable'
- readOnly: true
- cable_peer:
- type: object
- additionalProperties: {}
- nullable: true
- readOnly: true
- cable_peer_type:
- type: string
- nullable: true
- readOnly: true
- connected_endpoint:
- type: object
- additionalProperties: {}
- nullable: true
- readOnly: true
- connected_endpoint_type:
- type: string
- nullable: true
- readOnly: true
- connected_endpoint_reachable:
- type: boolean
- nullable: true
- readOnly: true
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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:
- - cable
- - cable_peer
- - cable_peer_type
- - computed_fields
- - connected_endpoint
- - connected_endpoint_reachable
- - connected_endpoint_type
- device
- - display
- - id
- name
- - url
- WritableConsoleServerPortTemplate:
+ WritableConsoleServerPortTemplateRequest:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
device_type:
type: string
format: uuid
name:
type: string
+ minLength: 1
maxLength: 64
label:
type: string
@@ -92378,23 +198116,120 @@ components:
custom_fields:
type: object
additionalProperties: {}
- display:
- type: string
- readOnly: true
- description: Human friendly display value
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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
- - display
- - id
- name
- - url
- WritableContactLCM:
+ WritableContactLCMRequest:
type: object
description: API serializer.
properties:
name:
type: string
nullable: true
+ minLength: 1
maxLength: 80
address:
type: string
@@ -92423,23 +198258,117 @@ components:
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
- display:
- type: string
- readOnly: true
- description: Human friendly display value
+ $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
- - display
- name
- WritableContractLCM:
+ WritableContractLCMRequest:
type: object
description: API serializer.
properties:
- id:
- type: string
- format: uuid
- readOnly: true
provider:
type: string
format: uuid
@@ -92447,6 +198376,7 @@ components:
title: Vendor
name:
type: string
+ minLength: 1
maxLength: 100
start:
type: string
@@ -92472,168 +198402,152 @@ components:
type: string
nullable: true
maxLength: 32
- expired:
- type: string
- readOnly: true
custom_fields:
type: object
additionalProperties: {}
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- required:
- - display
- - expired
- - id
- - name
- WritableCustomField:
- type: object
- description: |-
- Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
- validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)
- properties:
- id:
- type: string
- format: uuid
- readOnly: true
- url:
- type: string
- format: uri
- readOnly: true
- content_types:
- type: array
- items:
- type: string
- type:
- allOf:
- - $ref: '#/components/schemas/CustomFieldTypeChoices'
- description: The type of value(s) allowed for this field.
- name:
- type: string
- title: Slug
- description: URL-friendly unique shorthand.
- maxLength: 50
- label:
- type: string
- description: Name of the field as displayed to users (if not provided, the
- field's slug will be used.)
- maxLength: 50
- description:
- type: string
- description: A helpful description for this field.
- maxLength: 200
- required:
- type: boolean
- description: If true, this field is required when creating new objects or
- editing an existing object.
- filter_logic:
- allOf:
- - $ref: '#/components/schemas/FilterLogicEnum'
- description: Loose matches any instance of a given string; Exact matches
- the entire field.
- default:
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
+ relationships:
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
- display:
- type: string
- readOnly: true
- description: Human friendly display value
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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
- - display
- - id
- name
- - url
- WritableCustomFieldChoice:
+ 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:
- id:
- type: string
- format: uuid
- readOnly: true
- url:
- type: string
- format: uri
- readOnly: true
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
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- - display
- field
- - id
- - url
- value
- WritableDeviceBay:
+ WritableDeviceBayRequest:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
device:
type: string
format: uuid
name:
type: string
+ minLength: 1
maxLength: 64
label:
type: string
@@ -92649,43 +198563,129 @@ components:
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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:
- - computed_fields
- device
- - display
- - id
- name
- - url
- WritableDeviceBayTemplate:
+ WritableDeviceBayTemplateRequest:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
device_type:
type: string
format: uuid
name:
type: string
+ minLength: 1
maxLength: 64
label:
type: string
@@ -92697,39 +198697,268 @@ components:
custom_fields:
type: object
additionalProperties: {}
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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:
- - computed_fields
- device_type
- - display
- - id
- name
- - url
- WritableDeviceType:
+ WritableDeviceRedundancyGroupRequest:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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:
+ 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
- readOnly: true
- url:
+ nullable: true
+ comments:
type: string
- format: uri
- readOnly: true
+ 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
@@ -92756,60 +198985,132 @@ components:
- $ref: '#/components/schemas/BlankEnum'
front_image:
type: string
- format: uri
+ format: binary
rear_image:
type: string
- format: uri
+ format: binary
comments:
type: string
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- device_count:
- type: integer
- readOnly: true
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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:
- - computed_fields
- - created
- - device_count
- - display
- - id
- - last_updated
- manufacturer
- model
- - url
- WritableDeviceWithConfigContext:
+ WritableDeviceWithConfigContextRequest:
type: object
- description: Mixin to add `status` choice field to model serializers.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
name:
type: string
nullable: true
@@ -92840,6 +199141,10 @@ components:
site:
type: string
format: uuid
+ location:
+ type: string
+ format: uuid
+ nullable: true
rack:
type: string
format: uuid
@@ -92856,16 +199161,8 @@ components:
oneOf:
- $ref: '#/components/schemas/FaceEnum'
- $ref: '#/components/schemas/BlankEnum'
- parent_device:
- allOf:
- - $ref: '#/components/schemas/NestedDevice'
- readOnly: true
status:
- $ref: '#/components/schemas/WritableDeviceWithConfigContextStatusEnum'
- primary_ip:
- allOf:
- - $ref: '#/components/schemas/NestedIPAddress'
- readOnly: true
+ $ref: '#/components/schemas/DeviceStatusChoices'
primary_ip4:
type: string
format: uuid
@@ -92898,6 +199195,16 @@ components:
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:
@@ -92912,72 +199219,284 @@ components:
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
- computed_fields:
- type: object
- additionalProperties: {}
- readOnly: true
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- config_context:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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:
- - computed_fields
- - config_context
- - created
- device_role
- device_type
- - display
- - id
- - last_updated
- - parent_device
- - primary_ip
- site
- status
- - url
- WritableDeviceWithConfigContextStatusEnum:
- type: string
- enum:
- - active
- - decommissioning
- - failed
- - inventory
- - offline
- - planned
- - staged
- WritableFrontPort:
+ WritableDynamicGroupMembershipRequest:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an 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:
+ group:
type: string
format: uuid
- readOnly: true
- url:
+ parent_group:
type: string
- format: uri
- readOnly: true
+ 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
@@ -92996,64 +199515,134 @@ components:
description:
type: string
maxLength: 200
- cable:
- allOf:
- - $ref: '#/components/schemas/NestedCable'
- readOnly: true
- cable_peer:
- type: object
- additionalProperties: {}
- nullable: true
- readOnly: true
- cable_peer_type:
- type: string
- nullable: true
- readOnly: true
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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:
- - cable
- - cable_peer
- - cable_peer_type
- - computed_fields
- device
- - display
- - id
- name
- rear_port
- type
- - url
- WritableFrontPortTemplate:
+ WritableFrontPortTemplateRequest:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
device_type:
type: string
format: uuid
name:
type: string
+ minLength: 1
maxLength: 64
label:
type: string
@@ -93075,37 +199664,121 @@ components:
custom_fields:
type: object
additionalProperties: {}
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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:
- - computed_fields
- device_type
- - display
- - id
- name
- rear_port
- type
- - url
- WritableGitRepository:
+ WritableGitRepositoryRequest:
type: object
description: Git repositories defined as a data source.
properties:
- id:
- type: string
- format: uuid
- readOnly: true
- url:
- type: string
- format: uri
- readOnly: true
name:
type: string
+ minLength: 1
maxLength: 100
slug:
type: string
@@ -93114,14 +199787,17 @@ components:
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
@@ -93140,51 +199816,200 @@ components:
oneOf:
- $ref: '#/components/schemas/ProvidedContentsEnum'
- $ref: '#/components/schemas/BlankEnum'
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
custom_fields:
type: object
additionalProperties: {}
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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:
- - computed_fields
- - created
- - display
- - id
- - last_updated
- name
- remote_url
- - url
- WritableHardwareLCM:
+ 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:
- id:
- type: string
- format: uuid
- readOnly: true
- expired:
- type: string
- readOnly: true
- devices:
- type: array
- items:
- $ref: '#/components/schemas/NestedDevice'
- readOnly: true
- description: Devices tied to Device Type
device_type:
type: string
format: uuid
@@ -93225,34 +200050,120 @@ components:
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- required:
- - devices
- - display
- - expired
- - id
- WritableIPAddress:
+ $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: Mixin to add `status` choice field to model serializers.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
- family:
- allOf:
- - $ref: '#/components/schemas/FamilyEnum'
- readOnly: true
address:
type: string
+ minLength: 1
vrf:
type: string
format: uuid
@@ -93262,7 +200173,7 @@ components:
format: uuid
nullable: true
status:
- $ref: '#/components/schemas/WritableIPAddressStatusEnum'
+ $ref: '#/components/schemas/IPAddressStatusChoices'
role:
description: The functional role of this IP
oneOf:
@@ -93275,22 +200186,12 @@ components:
type: string
format: uuid
nullable: true
- assigned_object:
- type: object
- additionalProperties: {}
- nullable: true
- readOnly: true
nat_inside:
type: string
format: uuid
nullable: true
title: NAT (Inside)
description: The IP Addresses for which this address is the "outside" IP
- nat_outside:
- type: array
- items:
- $ref: '#/components/schemas/NestedIPAddress'
- readOnly: true
dns_name:
type: string
description: Hostname or FQDN (not case-sensitive)
@@ -93302,78 +200203,157 @@ components:
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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
- - assigned_object
- - computed_fields
- - created
- - display
- - family
- - id
- - last_updated
- - nat_outside
- status
- - url
- WritableIPAddressStatusEnum:
- type: string
- enum:
- - active
- - deprecated
- - dhcp
- - reserved
- - slaac
- WritableInterface:
+ WritableInterfaceRequest:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
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
@@ -93404,83 +200384,134 @@ components:
type: string
format: uuid
title: Tagged VLANs
- cable:
- allOf:
- - $ref: '#/components/schemas/NestedCable'
- readOnly: true
- cable_peer:
- type: object
- additionalProperties: {}
- nullable: true
- readOnly: true
- cable_peer_type:
- type: string
- nullable: true
- readOnly: true
- connected_endpoint:
- type: object
- additionalProperties: {}
- nullable: true
- readOnly: true
- connected_endpoint_type:
- type: string
- nullable: true
- readOnly: true
- connected_endpoint_reachable:
- type: boolean
- nullable: true
- readOnly: true
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
- count_ipaddresses:
- type: integer
- readOnly: true
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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:
- - cable
- - cable_peer
- - cable_peer_type
- - computed_fields
- - connected_endpoint
- - connected_endpoint_reachable
- - connected_endpoint_type
- - count_ipaddresses
- device
- - display
- - id
- name
+ - status
- type
- - url
- WritableInterfaceTemplate:
+ WritableInterfaceTemplateRequest:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
device_type:
type: string
format: uuid
name:
type: string
+ minLength: 1
maxLength: 64
label:
type: string
@@ -93497,35 +200528,120 @@ components:
custom_fields:
type: object
additionalProperties: {}
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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:
- - computed_fields
- device_type
- - display
- - id
- name
- type
- - url
- WritableInventoryItem:
+ WritableInventoryItemRequest:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
device:
type: string
format: uuid
@@ -93535,6 +200651,7 @@ components:
nullable: true
name:
type: string
+ minLength: 1
maxLength: 64
label:
type: string
@@ -93566,46 +200683,559 @@ components:
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
- _depth:
- type: integer
- readOnly: true
- title: ' depth'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- computed_fields:
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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:
- - _depth
- - computed_fields
- - device
- - display
- - id
+ - location_type
- name
- - url
- WritableObjectPermission:
+ - 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:
- id:
- type: string
- format: uuid
- readOnly: true
- url:
- type: string
- format: uri
- readOnly: true
name:
type: string
+ minLength: 1
maxLength: 100
description:
type: string
@@ -93635,32 +201265,163 @@ components:
nullable: true
description: Queryset filter matching the applicable objects of the selected
type(s)
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- actions
- - display
- - id
- name
- object_types
- - url
- WritablePlatform:
+ WritablePeerEndpointRequest:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: REST API serializer for PeerEndpoint records.
properties:
- id:
+ routing_instance:
type: string
format: uuid
- readOnly: true
- url:
+ nullable: true
+ title: BGP Routing Instance
+ source_ip:
type: string
- format: uri
- readOnly: true
+ 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
@@ -93686,53 +201447,269 @@ components:
description:
type: string
maxLength: 200
- device_count:
- type: integer
- readOnly: true
- virtualmachine_count:
- type: integer
- readOnly: true
custom_fields:
type: object
additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- computed_fields:
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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: {}
- readOnly: true
- display:
+ 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
- readOnly: true
- description: Human friendly display value
+ 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:
- - computed_fields
- - created
- - device_count
- - display
- - id
- - last_updated
+ - action
- name
- - url
- - virtualmachine_count
- WritablePowerFeed:
+ WritablePowerFeedRequest:
type: object
- description: Mixin to add `status` choice field to model serializers.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
power_panel:
type: string
format: uuid
@@ -93742,9 +201719,10 @@ components:
nullable: true
name:
type: string
+ minLength: 1
maxLength: 100
status:
- $ref: '#/components/schemas/WritablePowerFeedStatusEnum'
+ $ref: '#/components/schemas/PowerFeedStatusChoices'
type:
$ref: '#/components/schemas/PowerFeedTypeChoices'
supply:
@@ -93766,96 +201744,133 @@ components:
description: Maximum permissible draw (percentage)
comments:
type: string
- cable:
- allOf:
- - $ref: '#/components/schemas/NestedCable'
- readOnly: true
- cable_peer:
- type: object
- additionalProperties: {}
- nullable: true
- readOnly: true
- cable_peer_type:
- type: string
- nullable: true
- readOnly: true
- connected_endpoint:
- type: object
- additionalProperties: {}
- nullable: true
- readOnly: true
- connected_endpoint_type:
- type: string
- nullable: true
- readOnly: true
- connected_endpoint_reachable:
- type: boolean
- nullable: true
- readOnly: true
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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:
- - cable
- - cable_peer
- - cable_peer_type
- - computed_fields
- - connected_endpoint
- - connected_endpoint_reachable
- - connected_endpoint_type
- - created
- - display
- - id
- - last_updated
- name
- power_panel
- status
- - url
- WritablePowerFeedStatusEnum:
- type: string
- enum:
- - active
- - failed
- - offline
- - planned
- WritablePowerOutlet:
+ WritablePowerOutletRequest:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
device:
type: string
format: uuid
name:
type: string
+ minLength: 1
maxLength: 64
label:
type: string
@@ -93878,78 +201893,132 @@ components:
description:
type: string
maxLength: 200
- cable:
- allOf:
- - $ref: '#/components/schemas/NestedCable'
- readOnly: true
- cable_peer:
- type: object
- additionalProperties: {}
- nullable: true
- readOnly: true
- cable_peer_type:
- type: string
- nullable: true
- readOnly: true
- connected_endpoint:
- type: object
- additionalProperties: {}
- nullable: true
- readOnly: true
- connected_endpoint_type:
- type: string
- nullable: true
- readOnly: true
- connected_endpoint_reachable:
- type: boolean
- nullable: true
- readOnly: true
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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:
- - cable
- - cable_peer
- - cable_peer_type
- - computed_fields
- - connected_endpoint
- - connected_endpoint_reachable
- - connected_endpoint_type
- device
- - display
- - id
- name
- - url
- WritablePowerOutletTemplate:
+ WritablePowerOutletTemplateRequest:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
device_type:
type: string
format: uuid
name:
type: string
+ minLength: 1
maxLength: 64
label:
type: string
@@ -93974,88 +202043,260 @@ components:
custom_fields:
type: object
additionalProperties: {}
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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:
- - computed_fields
- device_type
- - display
- - id
- name
- - url
- WritablePowerPanel:
+ WritablePowerPanelRequest:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
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/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- powerfeed_count:
- type: integer
- readOnly: true
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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:
- - computed_fields
- - display
- - id
- name
- - powerfeed_count
- site
- - url
- WritablePowerPort:
+ WritablePowerPortRequest:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
device:
type: string
format: uuid
name:
type: string
+ minLength: 1
maxLength: 64
label:
type: string
@@ -94081,78 +202322,132 @@ components:
description:
type: string
maxLength: 200
- cable:
- allOf:
- - $ref: '#/components/schemas/NestedCable'
- readOnly: true
- cable_peer:
- type: object
- additionalProperties: {}
- nullable: true
- readOnly: true
- cable_peer_type:
- type: string
- nullable: true
- readOnly: true
- connected_endpoint:
- type: object
- additionalProperties: {}
- nullable: true
- readOnly: true
- connected_endpoint_type:
- type: string
- nullable: true
- readOnly: true
- connected_endpoint_reachable:
- type: boolean
- nullable: true
- readOnly: true
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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:
- - cable
- - cable_peer
- - cable_peer_type
- - computed_fields
- - connected_endpoint
- - connected_endpoint_reachable
- - connected_endpoint_type
- device
- - display
- - id
- name
- - url
- WritablePowerPortTemplate:
+ WritablePowerPortTemplateRequest:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
device_type:
type: string
format: uuid
name:
type: string
+ minLength: 1
maxLength: 64
label:
type: string
@@ -94180,43 +202475,130 @@ components:
custom_fields:
type: object
additionalProperties: {}
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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:
- - computed_fields
- device_type
- - display
- - id
- name
- - url
- WritablePrefix:
+ WritablePrefixRequest:
type: object
- description: Mixin to add `status` choice field to model serializers.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
- family:
- allOf:
- - $ref: '#/components/schemas/FamilyEnum'
- readOnly: true
prefix:
type: string
+ minLength: 1
site:
type: string
format: uuid
nullable: true
+ location:
+ type: string
+ format: uuid
+ nullable: true
vrf:
type: string
format: uuid
@@ -94230,7 +202612,7 @@ components:
format: uuid
nullable: true
status:
- $ref: '#/components/schemas/WritablePrefixStatusEnum'
+ $ref: '#/components/schemas/PrefixStatusChoices'
role:
type: string
format: uuid
@@ -94246,62 +202628,129 @@ components:
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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:
- - computed_fields
- - created
- - display
- - family
- - id
- - last_updated
- prefix
- status
- - url
- WritablePrefixStatusEnum:
- type: string
- enum:
- - active
- - container
- - deprecated
- - p2p
- - reserved
- WritableProviderNetwork:
+ WritableProviderNetworkRequest:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
provider:
type: string
format: uuid
name:
type: string
+ minLength: 1
maxLength: 100
slug:
type: string
@@ -94315,49 +202764,264 @@ components:
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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:
- - computed_fields
- - created
- - display
- - id
- - last_updated
- name
- provider
- - url
- WritableRack:
+ WritableRackGroupRequest:
type: object
- description: Mixin to add `status` choice field to model serializers.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
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
@@ -94367,6 +203031,10 @@ components:
site:
type: string
format: uuid
+ location:
+ type: string
+ format: uuid
+ nullable: true
group:
type: string
format: uuid
@@ -94377,7 +203045,7 @@ components:
format: uuid
nullable: true
status:
- $ref: '#/components/schemas/WritableRackStatusEnum'
+ $ref: '#/components/schemas/RackStatusChoices'
role:
type: string
format: uuid
@@ -94433,134 +203101,130 @@ components:
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- device_count:
- type: integer
- readOnly: true
- powerfeed_count:
- type: integer
- readOnly: true
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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:
- - computed_fields
- - created
- - device_count
- - display
- - id
- - last_updated
- name
- - powerfeed_count
- site
- status
- - url
- WritableRackGroup:
+ WritableRackReservationRequest:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
- name:
- type: string
- maxLength: 100
- slug:
- type: string
- maxLength: 100
- pattern: ^[-a-zA-Z0-9_]+$
- site:
- type: string
- format: uuid
- parent:
- type: string
- format: uuid
- nullable: true
- description:
- type: string
- maxLength: 200
- rack_count:
- type: integer
- readOnly: true
- _depth:
- type: integer
- readOnly: true
- title: ' depth'
- custom_fields:
- type: object
- additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- computed_fields:
- type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- required:
- - _depth
- - computed_fields
- - created
- - display
- - id
- - last_updated
- - name
- - rack_count
- - site
- - url
- WritableRackReservation:
- type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
- properties:
- id:
- type: string
- format: uuid
- readOnly: true
- url:
- type: string
- format: uri
- readOnly: true
rack:
type: string
format: uuid
units:
type: object
additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
user:
type: string
format: uuid
@@ -94570,58 +203234,136 @@ components:
nullable: true
description:
type: string
+ minLength: 1
maxLength: 200
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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:
- - computed_fields
- - created
- description
- - display
- - id
- rack
- units
- - url
- user
- WritableRackStatusEnum:
- type: string
- enum:
- - active
- - available
- - deprecated
- - planned
- - reserved
- WritableRearPort:
+ WritableRearPortRequest:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
device:
type: string
format: uuid
name:
type: string
+ minLength: 1
maxLength: 64
label:
type: string
@@ -94636,63 +203378,133 @@ components:
description:
type: string
maxLength: 200
- cable:
- allOf:
- - $ref: '#/components/schemas/NestedCable'
- readOnly: true
- cable_peer:
- type: object
- additionalProperties: {}
- nullable: true
- readOnly: true
- cable_peer_type:
- type: string
- nullable: true
- readOnly: true
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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:
- - cable
- - cable_peer
- - cable_peer_type
- - computed_fields
- device
- - display
- - id
- name
- type
- - url
- WritableRearPortTemplate:
+ WritableRearPortTemplateRequest:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
device_type:
type: string
format: uuid
name:
type: string
+ minLength: 1
maxLength: 64
label:
type: string
@@ -94710,32 +203522,123 @@ components:
custom_fields:
type: object
additionalProperties: {}
- display:
- type: string
- readOnly: true
- description: Human friendly display value
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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
- - display
- - id
- name
- type
- - url
- WritableRegion:
+ WritableRegionRequest:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
name:
type: string
+ minLength: 1
maxLength: 100
slug:
type: string
@@ -94748,49 +203651,120 @@ components:
description:
type: string
maxLength: 200
- site_count:
- type: integer
- readOnly: true
- _depth:
- type: integer
- readOnly: true
- title: ' depth'
custom_fields:
type: object
additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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:
- - _depth
- - computed_fields
- - created
- - display
- - id
- - last_updated
- name
- - site_count
- - url
- WritableRelationshipAssociation:
+ 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:
- id:
- type: string
- format: uuid
- readOnly: true
relationship:
type: string
format: uuid
@@ -94807,25 +203781,19 @@ components:
required:
- destination_id
- destination_type
- - id
- relationship
- source_id
- source_type
- WritableRouteTarget:
+ WritableRouteTargetRequest:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
name:
type: string
+ minLength: 1
description: Route target value (formatted in accordance with RFC 4360)
maxLength: 21
tenant:
@@ -94838,46 +203806,119 @@ components:
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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:
- - computed_fields
- - created
- - display
- - id
- - last_updated
- name
- - url
- WritableSecretsGroupAssociation:
+ WritableSecretsGroupAssociationRequest:
type: object
description: Serializer for `SecretsGroupAssociation` objects.
properties:
- id:
- type: string
- format: uuid
- readOnly: true
- url:
- type: string
- format: uri
- readOnly: true
group:
type: string
format: uuid
@@ -94888,31 +203929,147 @@ components:
secret:
type: string
format: uuid
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- access_type
- - display
- group
- - id
- secret
- secret_type
- - url
- WritableService:
+ WritableServiceObjectGroupRequest:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: ServiceObjectGroup Serializer.
properties:
- id:
+ 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
- format: uuid
- readOnly: true
- url:
+ maxLength: 200
+ name:
type: string
- format: uri
- readOnly: true
+ 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
@@ -94923,6 +204080,7 @@ components:
nullable: true
name:
type: string
+ minLength: 1
maxLength: 100
ports:
type: array
@@ -94945,57 +204103,134 @@ components:
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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:
- - computed_fields
- - created
- - display
- - id
- - last_updated
- name
- ports
- protocol
- - url
- WritableSite:
+ WritableSiteRequest:
type: object
- description: Mixin to add `status` choice field to model serializers.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
name:
type: string
+ minLength: 1
maxLength: 100
slug:
type: string
maxLength: 100
pattern: ^[-a-zA-Z0-9_]+$
status:
- $ref: '#/components/schemas/WritableSiteStatusEnum'
+ $ref: '#/components/schemas/LocationStatusChoices'
region:
type: string
format: uuid
@@ -95055,81 +204290,123 @@ components:
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- circuit_count:
- type: integer
- readOnly: true
- device_count:
- type: integer
- readOnly: true
- prefix_count:
- type: integer
- readOnly: true
- rack_count:
- type: integer
- readOnly: true
- virtualmachine_count:
- type: integer
- readOnly: true
- vlan_count:
- type: integer
- readOnly: true
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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_count
- - computed_fields
- - created
- - device_count
- - display
- - id
- - last_updated
- name
- - prefix_count
- - rack_count
- status
- - url
- - virtualmachine_count
- - vlan_count
- WritableSiteStatusEnum:
- type: string
- enum:
- - active
- - decommissioning
- - planned
- - retired
- - staging
- WritableSoftwareImageLCM:
+ WritableSoftwareImageLCMRequest:
type: object
description: REST API serializer for SoftwareImageLCM records.
properties:
- id:
- type: string
- format: uuid
- readOnly: true
- url:
- type: string
- format: uri
- readOnly: true
image_file_name:
type: string
+ minLength: 1
maxLength: 100
software:
type: string
@@ -95165,34 +204442,123 @@ components:
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
- display:
- type: string
- readOnly: true
- description: Human friendly display value
+ $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:
- - display
- - id
- image_file_name
- software
- - url
- WritableSoftwareLCM:
+ WritableSoftwareLCMRequest:
type: object
description: REST API serializer for SoftwareLCM records.
properties:
- id:
- type: string
- format: uuid
- readOnly: true
- url:
- type: string
- format: uri
- readOnly: true
device_platform:
type: string
format: uuid
version:
type: string
+ minLength: 1
maxLength: 50
alias:
type: string
@@ -95226,33 +204592,254 @@ components:
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
- display:
- type: string
- readOnly: true
- description: Human friendly display value
+ $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
- - display
- - id
- software_images
- - url
- version
- WritableTenant:
+ WritableTenantGroupRequest:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
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
@@ -95270,153 +204857,253 @@ components:
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- circuit_count:
- type: integer
- readOnly: true
- device_count:
- type: integer
- readOnly: true
- ipaddress_count:
- type: integer
- readOnly: true
- prefix_count:
- type: integer
- readOnly: true
- rack_count:
- type: integer
- readOnly: true
- site_count:
- type: integer
- readOnly: true
- virtualmachine_count:
- type: integer
- readOnly: true
- vlan_count:
- type: integer
- readOnly: true
- vrf_count:
- type: integer
- readOnly: true
- cluster_count:
- type: integer
- readOnly: true
- computed_fields:
+ relationships:
+ type: object
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- required:
- - circuit_count
- - cluster_count
- - computed_fields
- - created
- - device_count
- - display
- - id
- - ipaddress_count
- - last_updated
- - name
- - prefix_count
- - rack_count
- - site_count
- - url
- - virtualmachine_count
- - vlan_count
- - vrf_count
- WritableTenantGroup:
- type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
- properties:
- id:
- type: string
- format: uuid
- readOnly: true
- url:
- type: string
- format: uri
- readOnly: true
- name:
- type: string
- maxLength: 100
- slug:
- type: string
- maxLength: 100
- pattern: ^[-a-zA-Z0-9_]+$
- parent:
- type: string
- format: uuid
- nullable: true
+ _custom_field_data:
+ type: object
+ additionalProperties: {}
+ title: ' custom field data'
description:
type: string
maxLength: 200
- tenant_count:
- type: integer
- readOnly: true
- _depth:
- type: integer
- readOnly: true
- title: ' depth'
- custom_fields:
- type: object
- additionalProperties: {}
- created:
+ name:
type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- computed_fields:
- type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
+ minLength: 1
+ maxLength: 100
required:
- - _depth
- - computed_fields
- - created
- - display
- - id
- - last_updated
- name
- - tenant_count
- - url
- WritableUser:
+ 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:
- id:
- type: string
- format: uuid
- readOnly: true
- url:
- type: string
- format: uri
- readOnly: true
username:
type: string
+ minLength: 1
description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
pattern: ^[\w.@+-]+$
@@ -95424,6 +205111,7 @@ components:
password:
type: string
writeOnly: true
+ minLength: 1
maxLength: 128
first_name:
type: string
@@ -95454,32 +205142,158 @@ components:
type: integer
description: The groups this user belongs to. A user will get all permissions
granted to each of their groups.
- display:
- type: string
- readOnly: true
- description: Human friendly display value
required:
- - display
- - id
- password
- - url
- username
- WritableVLAN:
+ WritableVLANGroupRequest:
type: object
- description: Mixin to add `status` choice field to model serializers.
+ description: |-
+ Base class to use for serializers 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:
+ name:
+ type: string
+ minLength: 1
+ maxLength: 100
+ slug:
+ type: string
+ maxLength: 100
+ pattern: ^[-a-zA-Z0-9_]+$
+ site:
type: string
format: uuid
- readOnly: true
- url:
+ nullable: true
+ location:
type: string
- format: uri
- readOnly: true
+ 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
@@ -95491,13 +205305,14 @@ components:
title: ID
name:
type: string
+ minLength: 1
maxLength: 64
tenant:
type: string
format: uuid
nullable: true
status:
- $ref: '#/components/schemas/WritableVLANStatusEnum'
+ $ref: '#/components/schemas/VLANStatusChoices'
role:
type: string
format: uuid
@@ -95508,126 +205323,146 @@ components:
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- prefix_count:
- type: integer
- readOnly: true
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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:
- - computed_fields
- - created
- - display
- - id
- - last_updated
- name
- - prefix_count
- status
- - url
- vid
- WritableVLANGroup:
- type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
- properties:
- id:
- type: string
- format: uuid
- readOnly: true
- url:
- type: string
- format: uri
- readOnly: true
- name:
- type: string
- maxLength: 100
- slug:
- type: string
- maxLength: 100
- pattern: ^[-a-zA-Z0-9_]+$
- site:
- type: string
- format: uuid
- nullable: true
- description:
- type: string
- maxLength: 200
- vlan_count:
- type: integer
- readOnly: true
- custom_fields:
- type: object
- additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- computed_fields:
- type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
- required:
- - computed_fields
- - created
- - display
- - id
- - last_updated
- - name
- - url
- - vlan_count
- WritableVLANStatusEnum:
- type: string
- enum:
- - active
- - deprecated
- - reserved
- WritableVMInterface:
+ WritableVMInterfaceRequest:
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)
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
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
@@ -95657,32 +205492,127 @@ components:
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
- display:
- type: string
- readOnly: true
- description: Human friendly display value
+ $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:
- - display
- - id
- name
- - url
+ - status
- virtual_machine
- WritableVRF:
+ WritableVRFRequest:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
name:
type: string
+ minLength: 1
maxLength: 100
rd:
type: string
@@ -95714,54 +205644,119 @@ components:
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- created:
- type: string
- format: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
- readOnly: true
- ipaddress_count:
- type: integer
- readOnly: true
- prefix_count:
- type: integer
- readOnly: true
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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:
- - computed_fields
- - created
- - display
- - id
- - ipaddress_count
- - last_updated
- name
- - prefix_count
- - url
- WritableValidatedSoftwareLCM:
+ WritableValidatedSoftwareLCMRequest:
type: object
description: REST API serializer for ValidatedSoftwareLCM records.
properties:
- id:
- type: string
- format: uuid
- readOnly: true
- url:
- type: string
- format: uri
- readOnly: true
software:
type: string
format: uuid
@@ -95803,42 +205798,129 @@ components:
preferred:
type: boolean
title: Preferred Version
- valid:
- type: string
- readOnly: true
custom_fields:
type: object
additionalProperties: {}
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
- display:
- type: string
- readOnly: true
- description: Human friendly display value
+ $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:
- - display
- - id
- software
- start
- - url
- - valid
- WritableVirtualChassis:
+ WritableVirtualChassisRequest:
type: object
- description: Extends ModelSerializer to render any CustomFields and their values
- associated with an object.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
name:
type: string
+ minLength: 1
maxLength: 64
domain:
type: string
@@ -95850,49 +205932,128 @@ components:
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- member_count:
- type: integer
- readOnly: true
- computed_fields:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- display:
- type: string
- readOnly: true
- description: Human friendly display value
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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:
- - computed_fields
- - display
- - id
- - member_count
- name
- - url
- WritableVirtualMachineWithConfigContext:
+ WritableVirtualMachineWithConfigContextRequest:
type: object
- description: Mixin to add `status` choice field to model serializers.
+ description: |-
+ Base class to use for serializers 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
- url:
- type: string
- format: uri
- readOnly: true
name:
type: string
+ minLength: 1
maxLength: 64
status:
- $ref: '#/components/schemas/WritableVirtualMachineWithConfigContextStatusEnum'
- site:
- allOf:
- - $ref: '#/components/schemas/NestedSite'
- readOnly: true
+ $ref: '#/components/schemas/VirtualMachineStatusChoices'
cluster:
type: string
format: uuid
@@ -95908,10 +206069,6 @@ components:
type: string
format: uuid
nullable: true
- primary_ip:
- allOf:
- - $ref: '#/components/schemas/NestedIPAddress'
- readOnly: true
primary_ip4:
type: string
format: uuid
@@ -95953,47 +206110,333 @@ components:
tags:
type: array
items:
- $ref: '#/components/schemas/TagSerializerField'
+ $ref: '#/components/schemas/TagSerializerFieldRequest'
custom_fields:
type: object
additionalProperties: {}
- config_context:
+ relationships:
type: object
- additionalProperties: {}
- readOnly: true
- created:
+ additionalProperties:
+ type: object
+ required:
+ - id
+ - url
+ - name
+ - type
+ properties:
+ id:
+ type: string
+ format: uuid
+ readOnly: true
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ name:
+ type: string
+ readOnly: true
+ type:
+ type: string
+ readOnly: true
+ example: one-to-many
+ source:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ destination:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: array
+ items:
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ url:
+ type: string
+ format: uri
+ readOnly: true
+ display:
+ type: string
+ readOnly: true
+ additionalProperties: true
+ peer:
+ type: object
+ properties:
+ label:
+ type: string
+ readOnly: true
+ object_type:
+ type: string
+ readOnly: true
+ example: dcim.site
+ objects:
+ type: 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: date
- readOnly: true
- last_updated:
- type: string
- format: date-time
+ 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:
- - cluster
- - config_context
- created
- display
- id
- last_updated
- name
- - primary_ip
- - site
- - status
+ - notes_url
- url
- WritableVirtualMachineWithConfigContextStatusEnum:
- type: string
- enum:
- - active
- - decommissioning
- - failed
- - offline
- - planned
- - staged
+ - 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
diff --git a/docs/data-sources/manufacturers.md b/docs/data-sources/manufacturers.md
index d44b97b..499a2ca 100644
--- a/docs/data-sources/manufacturers.md
+++ b/docs/data-sources/manufacturers.md
@@ -34,6 +34,7 @@ Read-Only:
- `inventoryitem_count` (Number)
- `last_updated` (String)
- `name` (String)
+- `notes_url` (String)
- `platform_count` (Number)
- `slug` (String)
- `url` (String)
diff --git a/docs/resources/manufacturer.md b/docs/resources/manufacturer.md
index 7605ef5..a5db2fd 100644
--- a/docs/resources/manufacturer.md
+++ b/docs/resources/manufacturer.md
@@ -24,6 +24,7 @@ This object manages a manufacturer in Nautobot
- `custom_fields` (Map of String) Manufacturer custom fields.
- `description` (String) Manufacturer's description.
- `display` (String) Manufacturer's display name.
+- `notes_url` (String) Notes for manufacturer.
- `slug` (String) Manufacturer's slug.
- `url` (String) Manufacturer's URL.
diff --git a/go.mod b/go.mod
index df3bfa7..dd32858 100644
--- a/go.mod
+++ b/go.mod
@@ -1,76 +1,78 @@
module github.com/nleiva/terraform-provider-nautobot
-go 1.17
+go 1.20
require (
- github.com/deepmap/oapi-codegen v1.10.1
+ github.com/deepmap/oapi-codegen v1.12.4
+ github.com/google/uuid v1.3.0
github.com/hashicorp/terraform-plugin-docs v0.13.0
- github.com/hashicorp/terraform-plugin-log v0.7.0
- github.com/hashicorp/terraform-plugin-sdk/v2 v2.20.0
+ github.com/hashicorp/terraform-plugin-log v0.8.0
+ github.com/hashicorp/terraform-plugin-sdk/v2 v2.26.1
github.com/nautobot/go-nautobot v0.0.0-00010101000000-000000000000
- github.com/tidwall/gjson v1.14.3
+ github.com/tidwall/gjson v1.14.4
)
require (
github.com/Masterminds/goutils v1.1.1 // indirect
github.com/Masterminds/semver/v3 v3.1.1 // indirect
github.com/Masterminds/sprig/v3 v3.2.2 // indirect
- github.com/agext/levenshtein v1.2.2 // indirect
+ github.com/agext/levenshtein v1.2.3 // indirect
+ github.com/apapsch/go-jsonmerge/v2 v2.0.0 // indirect
github.com/apparentlymart/go-textseg/v13 v13.0.0 // indirect
github.com/armon/go-radix v1.0.0 // indirect
github.com/bgentry/speakeasy v0.1.0 // indirect
github.com/davecgh/go-spew v1.1.1 // indirect
- github.com/fatih/color v1.13.0 // indirect
- github.com/golang/protobuf v1.5.2 // indirect
- github.com/google/go-cmp v0.5.8 // indirect
- github.com/google/uuid v1.3.0 // indirect
+ github.com/fatih/color v1.15.0 // indirect
+ github.com/golang/protobuf v1.5.3 // indirect
+ github.com/google/go-cmp v0.5.9 // indirect
github.com/hashicorp/errwrap v1.1.0 // indirect
github.com/hashicorp/go-checkpoint v0.5.0 // indirect
github.com/hashicorp/go-cleanhttp v0.5.2 // indirect
github.com/hashicorp/go-cty v1.4.1-0.20200414143053-d3edf31b6320 // indirect
- github.com/hashicorp/go-hclog v1.2.1 // indirect
+ github.com/hashicorp/go-hclog v1.5.0 // indirect
github.com/hashicorp/go-multierror v1.1.1 // indirect
- github.com/hashicorp/go-plugin v1.4.4 // indirect
+ github.com/hashicorp/go-plugin v1.4.9 // indirect
github.com/hashicorp/go-uuid v1.0.3 // indirect
github.com/hashicorp/go-version v1.6.0 // indirect
- github.com/hashicorp/hc-install v0.4.0 // indirect
- github.com/hashicorp/hcl/v2 v2.13.0 // indirect
+ github.com/hashicorp/hc-install v0.5.0 // indirect
+ github.com/hashicorp/hcl/v2 v2.16.2 // indirect
github.com/hashicorp/logutils v1.0.0 // indirect
- github.com/hashicorp/terraform-exec v0.17.2 // indirect
- github.com/hashicorp/terraform-json v0.14.0 // indirect
- github.com/hashicorp/terraform-plugin-go v0.12.0 // indirect
- github.com/hashicorp/terraform-registry-address v0.0.0-20220623143253-7d51757b572c // indirect
- github.com/hashicorp/terraform-svchost v0.0.0-20200729002733-f050f53b9734 // indirect
- github.com/hashicorp/yamux v0.0.0-20181012175058-2f1d1f20f75d // indirect
+ github.com/hashicorp/terraform-exec v0.18.1 // indirect
+ github.com/hashicorp/terraform-json v0.16.0 // indirect
+ github.com/hashicorp/terraform-plugin-go v0.14.3 // indirect
+ github.com/hashicorp/terraform-registry-address v0.2.0 // indirect
+ github.com/hashicorp/terraform-svchost v0.1.0 // indirect
+ github.com/hashicorp/yamux v0.1.1 // indirect
github.com/huandu/xstrings v1.3.2 // indirect
github.com/imdario/mergo v0.3.13 // indirect
- github.com/mattn/go-colorable v0.1.12 // indirect
- github.com/mattn/go-isatty v0.0.14 // indirect
- github.com/mitchellh/cli v1.1.4 // indirect
+ github.com/mattn/go-colorable v0.1.13 // indirect
+ github.com/mattn/go-isatty v0.0.18 // indirect
+ github.com/mitchellh/cli v1.1.5 // indirect
github.com/mitchellh/copystructure v1.2.0 // indirect
github.com/mitchellh/go-testing-interface v1.14.1 // indirect
- github.com/mitchellh/go-wordwrap v1.0.0 // indirect
+ github.com/mitchellh/go-wordwrap v1.0.1 // indirect
github.com/mitchellh/mapstructure v1.5.0 // indirect
github.com/mitchellh/reflectwalk v1.0.2 // indirect
- github.com/oklog/run v1.0.0 // indirect
+ github.com/oklog/run v1.1.0 // indirect
github.com/posener/complete v1.2.3 // indirect
github.com/russross/blackfriday v1.6.0 // indirect
github.com/shopspring/decimal v1.3.1 // indirect
github.com/spf13/cast v1.5.0 // indirect
github.com/tidwall/match v1.1.1 // indirect
- github.com/tidwall/pretty v1.2.0 // indirect
+ github.com/tidwall/pretty v1.2.1 // indirect
github.com/vmihailenco/msgpack v4.0.4+incompatible // indirect
github.com/vmihailenco/msgpack/v4 v4.3.12 // indirect
- github.com/vmihailenco/tagparser v0.1.1 // indirect
- github.com/zclconf/go-cty v1.10.0 // indirect
- golang.org/x/crypto v0.0.0-20220622213112-05595931fe9d // indirect
- golang.org/x/net v0.0.0-20220418201149-a630d4f3e7a2 // indirect
- golang.org/x/sys v0.0.0-20220627191245-f75cf1eec38b // indirect
- golang.org/x/text v0.3.7 // indirect
- google.golang.org/appengine v1.6.6 // indirect
- google.golang.org/genproto v0.0.0-20200711021454-869866162049 // indirect
- google.golang.org/grpc v1.48.0 // indirect
- google.golang.org/protobuf v1.28.0 // indirect
+ github.com/vmihailenco/tagparser v0.1.2 // indirect
+ github.com/zclconf/go-cty v1.13.1 // indirect
+ golang.org/x/crypto v0.7.0 // indirect
+ golang.org/x/mod v0.9.0 // indirect
+ golang.org/x/net v0.8.0 // indirect
+ golang.org/x/sys v0.6.0 // indirect
+ golang.org/x/text v0.8.0 // indirect
+ google.golang.org/appengine v1.6.7 // indirect
+ google.golang.org/genproto v0.0.0-20230323212658-478b75c54725 // indirect
+ google.golang.org/grpc v1.54.0 // indirect
+ google.golang.org/protobuf v1.30.0 // indirect
)
replace github.com/nautobot/go-nautobot => ./client
diff --git a/go.sum b/go.sum
index 5ab54f4..032bfb9 100644
--- a/go.sum
+++ b/go.sum
@@ -7,6 +7,7 @@ github.com/Masterminds/goutils v1.1.1/go.mod h1:8cTjp+g8YejhMuvIA5y2vz3BpJxksy86
github.com/Masterminds/semver/v3 v3.1.1 h1:hLg3sBzpNErnxhQtUy/mmLR2I9foDujNK030IGemrRc=
github.com/Masterminds/semver/v3 v3.1.1/go.mod h1:VPu/7SZ7ePZ3QOrcuXROw5FAcLl4a0cBrbBpGY/8hQs=
github.com/Masterminds/sprig/v3 v3.2.0/go.mod h1:tWhwTbUTndesPNeF0C900vKoq283u6zp4APT9vaF3SI=
+github.com/Masterminds/sprig/v3 v3.2.1/go.mod h1:UoaO7Yp8KlPnJIYWTFkMaqPUYKTfGFPhxNuwnnxkKlk=
github.com/Masterminds/sprig/v3 v3.2.2 h1:17jRggJu518dr3QaafizSXOjKYp94wKfABxUmyxvxX8=
github.com/Masterminds/sprig/v3 v3.2.2/go.mod h1:UoaO7Yp8KlPnJIYWTFkMaqPUYKTfGFPhxNuwnnxkKlk=
github.com/Microsoft/go-winio v0.4.14/go.mod h1:qXqCSQ3Xa7+6tgxaGTIe4Kpcdsi+P8jBhyzoq1bpyYA=
@@ -14,14 +15,20 @@ github.com/Microsoft/go-winio v0.4.16 h1:FtSW/jqD+l4ba5iPBj9CODVtgfYAD8w2wS923g/
github.com/Microsoft/go-winio v0.4.16/go.mod h1:XB6nPKklQyQ7GC9LdcBEcBl8PF76WugXOPRXwdLnMv0=
github.com/ProtonMail/go-crypto v0.0.0-20210428141323-04723f9f07d7 h1:YoJbenK9C67SkzkDfmQuVln04ygHj3vjZfd9FL+GmQQ=
github.com/ProtonMail/go-crypto v0.0.0-20210428141323-04723f9f07d7/go.mod h1:z4/9nQmJSSwwds7ejkxaJwO37dru3geImFUdJlaLzQo=
+github.com/RaveNoX/go-jsoncommentstrip v1.0.0/go.mod h1:78ihd09MekBnJnxpICcwzCMzGrKSKYe4AqU6PDYYpjk=
github.com/acomagu/bufpipe v1.0.3 h1:fxAGrHZTgQ9w5QqVItgzwj235/uYZYgbXitB+dLupOk=
github.com/acomagu/bufpipe v1.0.3/go.mod h1:mxdxdup/WdsKVreO5GpW4+M/1CE2sMG4jeGJ2sYmHc4=
github.com/agext/levenshtein v1.2.1/go.mod h1:JEDfjyjHDjOF/1e4FlBE/PkbqA9OfWu2ki2W0IB5558=
github.com/agext/levenshtein v1.2.2 h1:0S/Yg6LYmFJ5stwQeRp6EeOcCbj7xiqQSdNelsXvaqE=
github.com/agext/levenshtein v1.2.2/go.mod h1:JEDfjyjHDjOF/1e4FlBE/PkbqA9OfWu2ki2W0IB5558=
+github.com/agext/levenshtein v1.2.3 h1:YB2fHEn0UJagG8T1rrWknE3ZQzWM06O8AMAatNn7lmo=
+github.com/agext/levenshtein v1.2.3/go.mod h1:JEDfjyjHDjOF/1e4FlBE/PkbqA9OfWu2ki2W0IB5558=
github.com/anmitsu/go-shlex v0.0.0-20161002113705-648efa622239/go.mod h1:2FmKhYUyUczH0OGQWaF5ceTx0UBShxjsH6f8oGKYe2c=
github.com/antihax/optional v1.0.0/go.mod h1:uupD/76wgC+ih3iEmQUL+0Ugr19nfwCT1kdvxnR2qWY=
+github.com/apapsch/go-jsonmerge/v2 v2.0.0 h1:axGnT1gRIfimI7gJifB699GoE/oq+F2MU7Dml6nw9rQ=
+github.com/apapsch/go-jsonmerge/v2 v2.0.0/go.mod h1:lvDnEdqiQrp0O42VQGgmlKpxL1AP2+08jFMw88y4klk=
github.com/apparentlymart/go-cidr v1.1.0/go.mod h1:EBcsNrHc3zQeuaeCeCtQruQm+n9/YjEn/vI25Lg7Gwc=
+github.com/apparentlymart/go-dump v0.0.0-20180507223929-23540a00eaa3 h1:ZSTrOEhiM5J5RFxEaFvMZVEAM1KvT1YzbEOwB2EAGjA=
github.com/apparentlymart/go-dump v0.0.0-20180507223929-23540a00eaa3/go.mod h1:oL81AME2rN47vu18xqj1S1jPIPuN7afo62yKTNn3XMM=
github.com/apparentlymart/go-dump v0.0.0-20190214190832-042adf3cf4a0 h1:MzVXffFUye+ZcSR6opIgz9Co7WcDx6ZcY+RjfFHoA0I=
github.com/apparentlymart/go-dump v0.0.0-20190214190832-042adf3cf4a0/go.mod h1:oL81AME2rN47vu18xqj1S1jPIPuN7afo62yKTNn3XMM=
@@ -36,6 +43,7 @@ github.com/armon/go-radix v1.0.0/go.mod h1:ufUuZ+zHj4x4TnLV4JWEpy2hxWSpsRywHrMgI
github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5/go.mod h1:wHh0iHkYZB8zMSxRWpUBQtwG5a7fFgvEO+odwuTv2gs=
github.com/bgentry/speakeasy v0.1.0 h1:ByYyxL9InA1OWqxJqqp2A5pYHUrCiAL6K3J+LKSsQkY=
github.com/bgentry/speakeasy v0.1.0/go.mod h1:+zsyZBPWlz7T6j88CTgSN5bM796AkVf0kBD4zp0CCIs=
+github.com/bmatcuk/doublestar v1.1.1/go.mod h1:UD6OnuiIn0yFxxA2le/rnRU1G4RaI4UvFv1sNto9p6w=
github.com/census-instrumentation/opencensus-proto v0.2.1/go.mod h1:f6KPmirojxKA12rnyqOA5BBL4O983OfeGPqjHWSTneU=
github.com/cespare/xxhash/v2 v2.1.1/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
github.com/client9/misspell v0.3.4/go.mod h1:qj6jICC3Q7zFZvVWo7KLAzC3yx5G7kyvSDkc90ppPyw=
@@ -55,6 +63,8 @@ github.com/decred/dcrd/dcrec/secp256k1/v4 v4.0.0-20210816181553-5444fa50b93d/go.
github.com/decred/dcrd/dcrec/secp256k1/v4 v4.0.1/go.mod h1:hyedUtir6IdtD/7lIxGeCxkaw7y45JueMRL4DIyJDKs=
github.com/deepmap/oapi-codegen v1.10.1 h1:xybuJUR6D8l7P+LAuxOm5SD7nTlFKHWvOPl31q+DDVs=
github.com/deepmap/oapi-codegen v1.10.1/go.mod h1:TvVmDQlUkFli9gFij/gtW1o+tFBr4qCHyv2zG+R0YZY=
+github.com/deepmap/oapi-codegen v1.12.4 h1:pPmn6qI9MuOtCz82WY2Xaw46EQjgvxednXXrP7g5Q2s=
+github.com/deepmap/oapi-codegen v1.12.4/go.mod h1:3lgHGMu6myQ2vqbbTXH2H1o4eXFTGnFiDaOaKKl5yas=
github.com/emirpasic/gods v1.12.0 h1:QAUIPSaCu4G+POclxeqb3F+WPpdKqFGlw36+yOzGlrg=
github.com/emirpasic/gods v1.12.0/go.mod h1:YfzfFFoVP/catgzJb4IKIqXjX78Ha8FMSDh3ymbK86o=
github.com/envoyproxy/go-control-plane v0.9.0/go.mod h1:YTl/9mNaCwkRvm6d1a2C3ymFceY/DCBVvsKhRF0iEA4=
@@ -66,6 +76,8 @@ github.com/envoyproxy/protoc-gen-validate v0.1.0/go.mod h1:iSmxcyjqTsJpI2R4NaDN7
github.com/fatih/color v1.7.0/go.mod h1:Zm6kSWBoL9eyXnKyktHP6abPY2pDugNf5KwzbycvMj4=
github.com/fatih/color v1.13.0 h1:8LOYc1KYPPmyKMuN8QV2DNRWNbLo6LZ0iLs8+mlH53w=
github.com/fatih/color v1.13.0/go.mod h1:kLAiJbzzSOZDVNGyDpeOxJ47H46qBXwg5ILebYFFOfk=
+github.com/fatih/color v1.15.0 h1:kOqh6YHBtK8aywxGerMG2Eq3H6Qgoqeo13Bk2Mv/nBs=
+github.com/fatih/color v1.15.0/go.mod h1:0h5ZqXfHYED7Bhv2ZJamyIOUej9KtShiJESRwBDUSsw=
github.com/flynn/go-shlex v0.0.0-20150515145356-3f9db97f8568/go.mod h1:xEzjJPgXI435gkrCt3MPfRiAkVrwSbHsst4LCFVfpJc=
github.com/frankban/quicktest v1.14.3 h1:FJKSZTDHjyhriyC81FLQ0LY93eSai0ZyR/ZIkd3ZUKE=
github.com/frankban/quicktest v1.14.3/go.mod h1:mgiwOwqx65TmIk1wJ6Q7wvnVMocbUorkibMOrVTHZps=
@@ -116,6 +128,8 @@ github.com/golang/protobuf v1.4.3/go.mod h1:oDoupMAO8OvCJWAcko0GGGIgR6R6ocIYbsSw
github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaSAoJOfIk=
github.com/golang/protobuf v1.5.2 h1:ROPKBNFfQgOUMifHyP+KYbvpjbdoFNs+aK7DXlji0Tw=
github.com/golang/protobuf v1.5.2/go.mod h1:XVQd3VNwM+JqD3oG2Ue2ip4fOMUkwXdXDdiuN0vRsmY=
+github.com/golang/protobuf v1.5.3 h1:KhyjKVUg7Usr/dYsdSqoFveMYd5ko72D+zANwlG1mmg=
+github.com/golang/protobuf v1.5.3/go.mod h1:XVQd3VNwM+JqD3oG2Ue2ip4fOMUkwXdXDdiuN0vRsmY=
github.com/golangci/lint-1 v0.0.0-20181222135242-d2cdd8c08219/go.mod h1:/X8TswGSh1pIozq4ZwCfxS0WA5JGXguxk94ar/4c87Y=
github.com/google/go-cmp v0.2.0/go.mod h1:oXzfMopK8JAjlY9xF4vHSVASa0yLyX7SntLO5aqRK0M=
github.com/google/go-cmp v0.3.0/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU=
@@ -127,6 +141,8 @@ github.com/google/go-cmp v0.5.6/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/
github.com/google/go-cmp v0.5.7/go.mod h1:n+brtR0CgQNWTVd5ZUFpTBC8YFBDLK/h/bpaJ8/DtOE=
github.com/google/go-cmp v0.5.8 h1:e6P7q2lk1O+qJJb4BtCQXlK8vWEO8V1ZeuEdJNOqZyg=
github.com/google/go-cmp v0.5.8/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
+github.com/google/go-cmp v0.5.9 h1:O2Tfq5qg4qc4AmwVlvv0oLiVAGB7enBSJ2x2DqQFi38=
+github.com/google/go-cmp v0.5.9/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg=
github.com/google/uuid v1.1.1/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
github.com/google/uuid v1.1.2/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
@@ -148,11 +164,15 @@ github.com/hashicorp/go-cty v1.4.1-0.20200414143053-d3edf31b6320/go.mod h1:EiZBM
github.com/hashicorp/go-hclog v0.14.1/go.mod h1:whpDNt7SSdeAju8AWKIWsul05p54N/39EeqMAyrmvFQ=
github.com/hashicorp/go-hclog v1.2.1 h1:YQsLlGDJgwhXFpucSPyVbCBviQtjlHv3jLTlp8YmtEw=
github.com/hashicorp/go-hclog v1.2.1/go.mod h1:W4Qnvbt70Wk/zYJryRzDRU/4r0kIg0PVHBcfoyhpF5M=
+github.com/hashicorp/go-hclog v1.5.0 h1:bI2ocEMgcVlz55Oj1xZNBsVi900c7II+fWDyV9o+13c=
+github.com/hashicorp/go-hclog v1.5.0/go.mod h1:W4Qnvbt70Wk/zYJryRzDRU/4r0kIg0PVHBcfoyhpF5M=
github.com/hashicorp/go-multierror v1.0.0/go.mod h1:dHtQlpGsu+cZNNAkkCN/P3hoUDHhCYQXV3UM06sGGrk=
github.com/hashicorp/go-multierror v1.1.1 h1:H5DkEtf6CXdFp0N0Em5UCwQpXMWke8IA0+lD48awMYo=
github.com/hashicorp/go-multierror v1.1.1/go.mod h1:iw975J/qwKPdAO1clOe2L8331t/9/fmwbPZ6JB6eMoM=
github.com/hashicorp/go-plugin v1.4.4 h1:NVdrSdFRt3SkZtNckJ6tog7gbpRrcbOjQi/rgF7JYWQ=
github.com/hashicorp/go-plugin v1.4.4/go.mod h1:viDMjcLJuDui6pXb8U4HVfb8AamCWhHGUjr2IrTF67s=
+github.com/hashicorp/go-plugin v1.4.9 h1:ESiK220/qE0aGxWdzKIvRH69iLiuN/PjoLTm69RoWtU=
+github.com/hashicorp/go-plugin v1.4.9/go.mod h1:viDMjcLJuDui6pXb8U4HVfb8AamCWhHGUjr2IrTF67s=
github.com/hashicorp/go-uuid v1.0.0/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro=
github.com/hashicorp/go-uuid v1.0.3 h1:2gKiV6YVmrJ1i2CKKa9obLvRieoRGviZFL26PcT/Co8=
github.com/hashicorp/go-uuid v1.0.3/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro=
@@ -162,30 +182,50 @@ github.com/hashicorp/go-version v1.6.0 h1:feTTfFNnjP967rlCxM/I9g701jU+RN74YKx2mO
github.com/hashicorp/go-version v1.6.0/go.mod h1:fltr4n8CU8Ke44wwGCBoEymUuxUHl09ZGVZPK5anwXA=
github.com/hashicorp/hc-install v0.4.0 h1:cZkRFr1WVa0Ty6x5fTvL1TuO1flul231rWkGH92oYYk=
github.com/hashicorp/hc-install v0.4.0/go.mod h1:5d155H8EC5ewegao9A4PUTMNPZaq+TbOzkJJZ4vrXeI=
+github.com/hashicorp/hc-install v0.5.0 h1:D9bl4KayIYKEeJ4vUDe9L5huqxZXczKaykSRcmQ0xY0=
+github.com/hashicorp/hc-install v0.5.0/go.mod h1:JyzMfbzfSBSjoDCRPna1vi/24BEDxFaCPfdHtM5SCdo=
github.com/hashicorp/hcl/v2 v2.13.0 h1:0Apadu1w6M11dyGFxWnmhhcMjkbAiKCv7G1r/2QgCNc=
github.com/hashicorp/hcl/v2 v2.13.0/go.mod h1:e4z5nxYlWNPdDSNYX+ph14EvWYMFm3eP0zIUqPc2jr0=
+github.com/hashicorp/hcl/v2 v2.16.2 h1:mpkHZh/Tv+xet3sy3F9Ld4FyI2tUpWe9x3XtPx9f1a0=
+github.com/hashicorp/hcl/v2 v2.16.2/go.mod h1:JRmR89jycNkrrqnMmvPDMd56n1rQJ2Q6KocSLCMCXng=
github.com/hashicorp/logutils v1.0.0 h1:dLEQVugN8vlakKOUE3ihGLTZJRB4j+M2cdTm/ORI65Y=
github.com/hashicorp/logutils v1.0.0/go.mod h1:QIAnNjmIWmVIIkWDTG1z5v++HQmx9WQRO+LraFDTW64=
github.com/hashicorp/terraform-exec v0.17.2 h1:EU7i3Fh7vDUI9nNRdMATCEfnm9axzTnad8zszYZ73Go=
github.com/hashicorp/terraform-exec v0.17.2/go.mod h1:tuIbsL2l4MlwwIZx9HPM+LOV9vVyEfBYu2GsO1uH3/8=
+github.com/hashicorp/terraform-exec v0.18.1 h1:LAbfDvNQU1l0NOQlTuudjczVhHj061fNX5H8XZxHlH4=
+github.com/hashicorp/terraform-exec v0.18.1/go.mod h1:58wg4IeuAJ6LVsLUeD2DWZZoc/bYi6dzhLHzxM41980=
github.com/hashicorp/terraform-json v0.14.0 h1:sh9iZ1Y8IFJLx+xQiKHGud6/TSUCM0N8e17dKDpqV7s=
github.com/hashicorp/terraform-json v0.14.0/go.mod h1:5A9HIWPkk4e5aeeXIBbkcOvaZbIYnAIkEyqP2pNSckM=
+github.com/hashicorp/terraform-json v0.16.0 h1:UKkeWRWb23do5LNAFlh/K3N0ymn1qTOO8c+85Albo3s=
+github.com/hashicorp/terraform-json v0.16.0/go.mod h1:v0Ufk9jJnk6tcIZvScHvetlKfiNTC+WS21mnXIlc0B0=
github.com/hashicorp/terraform-plugin-docs v0.13.0 h1:6e+VIWsVGb6jYJewfzq2ok2smPzZrt1Wlm9koLeKazY=
github.com/hashicorp/terraform-plugin-docs v0.13.0/go.mod h1:W0oCmHAjIlTHBbvtppWHe8fLfZ2BznQbuv8+UD8OucQ=
github.com/hashicorp/terraform-plugin-go v0.12.0 h1:6wW9mT1dSs0Xq4LR6HXj1heQ5ovr5GxXNJwkErZzpJw=
github.com/hashicorp/terraform-plugin-go v0.12.0/go.mod h1:kwhmaWHNDvT1B3QiSJdAtrB/D4RaKSY/v3r2BuoWK4M=
+github.com/hashicorp/terraform-plugin-go v0.14.3 h1:nlnJ1GXKdMwsC8g1Nh05tK2wsC3+3BL/DBBxFEki+j0=
+github.com/hashicorp/terraform-plugin-go v0.14.3/go.mod h1:7ees7DMZ263q8wQ6E4RdIdR6nHHJtrdt4ogX5lPkX1A=
github.com/hashicorp/terraform-plugin-log v0.6.0/go.mod h1:p4R1jWBXRTvL4odmEkFfDdhUjHf9zcs/BCoNHAc7IK4=
github.com/hashicorp/terraform-plugin-log v0.7.0 h1:SDxJUyT8TwN4l5b5/VkiTIaQgY6R+Y2BQ0sRZftGKQs=
github.com/hashicorp/terraform-plugin-log v0.7.0/go.mod h1:p4R1jWBXRTvL4odmEkFfDdhUjHf9zcs/BCoNHAc7IK4=
+github.com/hashicorp/terraform-plugin-log v0.8.0 h1:pX2VQ/TGKu+UU1rCay0OlzosNKe4Nz1pepLXj95oyy0=
+github.com/hashicorp/terraform-plugin-log v0.8.0/go.mod h1:1myFrhVsBLeylQzYYEV17VVjtG8oYPRFdaZs7xdW2xs=
github.com/hashicorp/terraform-plugin-sdk/v2 v2.20.0 h1:+KxZULPsbjpAVoP0WNj/8aVW6EqpcX5JcUcQ5wl7Da4=
github.com/hashicorp/terraform-plugin-sdk/v2 v2.20.0/go.mod h1:DwGJG3KNxIPluVk6hexvDfYR/MS/eKGpiztJoT3Bbbw=
+github.com/hashicorp/terraform-plugin-sdk/v2 v2.26.1 h1:G9WAfb8LHeCxu7Ae8nc1agZlQOSCUWsb610iAogBhCs=
+github.com/hashicorp/terraform-plugin-sdk/v2 v2.26.1/go.mod h1:xcOSYlRVdPLmDUoqPhO9fiO/YCN/l6MGYeTzGt5jgkQ=
github.com/hashicorp/terraform-registry-address v0.0.0-20220623143253-7d51757b572c h1:D8aRO6+mTqHfLsK/BC3j5OAoogv1WLRWzY1AaTo3rBg=
github.com/hashicorp/terraform-registry-address v0.0.0-20220623143253-7d51757b572c/go.mod h1:Wn3Na71knbXc1G8Lh+yu/dQWWJeFQEpDeJMtWMtlmNI=
+github.com/hashicorp/terraform-registry-address v0.2.0 h1:92LUg03NhfgZv44zpNTLBGIbiyTokQCDcdH5BhVHT3s=
+github.com/hashicorp/terraform-registry-address v0.2.0/go.mod h1:478wuzJPzdmqT6OGbB/iH82EDcI8VFM4yujknh/1nIs=
github.com/hashicorp/terraform-svchost v0.0.0-20200729002733-f050f53b9734 h1:HKLsbzeOsfXmKNpr3GiT18XAblV0BjCbzL8KQAMZGa0=
github.com/hashicorp/terraform-svchost v0.0.0-20200729002733-f050f53b9734/go.mod h1:kNDNcF7sN4DocDLBkQYz73HGKwN1ANB1blq4lIYLYvg=
+github.com/hashicorp/terraform-svchost v0.1.0 h1:0+RcgZdZYNd81Vw7tu62g9JiLLvbOigp7QtyNh6CjXk=
+github.com/hashicorp/terraform-svchost v0.1.0/go.mod h1:ut8JaH0vumgdCfJaihdcZULqkAwHdQNwNH7taIDdsZM=
github.com/hashicorp/yamux v0.0.0-20180604194846-3520598351bb/go.mod h1:+NfK9FKeTrX5uv1uIXGdwYDTeHna2qgaIlx54MXqjAM=
github.com/hashicorp/yamux v0.0.0-20181012175058-2f1d1f20f75d h1:kJCB4vdITiW1eC1vq2e6IsrXKrZit1bv/TDYFGMp4BQ=
github.com/hashicorp/yamux v0.0.0-20181012175058-2f1d1f20f75d/go.mod h1:+NfK9FKeTrX5uv1uIXGdwYDTeHna2qgaIlx54MXqjAM=
+github.com/hashicorp/yamux v0.1.1 h1:yrQxtgseBDrq9Y652vSRDvsKCJKOUD+GzTS4Y0Y8pvE=
+github.com/hashicorp/yamux v0.1.1/go.mod h1:CtWFDAQgb7dxtzFs4tWbplKIe2jSi3+5vKbgIO0SLnQ=
github.com/huandu/xstrings v1.3.1/go.mod h1:y5/lhBue+AyNmUVz9RLU9xbLR0o4KIIExikq4ovT0aE=
github.com/huandu/xstrings v1.3.2 h1:L18LIDzqlW6xN2rEkpdV8+oL/IXWJ1APd+vsdYy4Wdw=
github.com/huandu/xstrings v1.3.2/go.mod h1:y5/lhBue+AyNmUVz9RLU9xbLR0o4KIIExikq4ovT0aE=
@@ -201,6 +241,7 @@ github.com/jhump/protoreflect v1.6.0/go.mod h1:eaTn3RZAmMBcV0fifFvlm6VHNz3wSkYyX
github.com/josharian/intern v1.0.0/go.mod h1:5DoeVV0s6jJacbCEi61lwdGj/aVlrQvzHFFd8Hwg//Y=
github.com/json-iterator/go v1.1.9/go.mod h1:KdQUCv79m/52Kvf8AW2vK1V8akMuk1QjK/uOdHXbAo4=
github.com/json-iterator/go v1.1.12/go.mod h1:e30LSqwooZae/UwlEbR2852Gd8hjQvJoHmT4TnhNGBo=
+github.com/juju/gnuflag v0.0.0-20171113085948-2ce1bb71843d/go.mod h1:2PavIy+JPciBPrBUjwbNvtwB6RQlve+hkpll6QSNmOE=
github.com/kevinburke/ssh_config v0.0.0-20201106050909-4977a11b4351 h1:DowS9hvgyYSX4TO5NpyC606/Z4SxnNYbT+WX27or6Ck=
github.com/kevinburke/ssh_config v0.0.0-20201106050909-4977a11b4351/go.mod h1:CT57kijsi8u/K/BOFA39wgDQJ9CxiF4nAY/ojJ6r6mM=
github.com/konsorten/go-windows-terminal-sequences v1.0.1/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ=
@@ -239,14 +280,21 @@ github.com/mattn/go-colorable v0.1.9/go.mod h1:u6P/XSegPjTcexA+o6vUJrdnUu04hMope
github.com/mattn/go-colorable v0.1.11/go.mod h1:u5H1YNBxpqRaxsYJYSkiCWKzEfiAb1Gb520KVy5xxl4=
github.com/mattn/go-colorable v0.1.12 h1:jF+Du6AlPIjs2BiUiQlKOX0rt3SujHxPnksPKZbaA40=
github.com/mattn/go-colorable v0.1.12/go.mod h1:u5H1YNBxpqRaxsYJYSkiCWKzEfiAb1Gb520KVy5xxl4=
+github.com/mattn/go-colorable v0.1.13 h1:fFA4WZxdEF4tXPZVKMLwD8oUnCTTo08duU7wxecdEvA=
+github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovkB8vQcUbaXHg=
github.com/mattn/go-isatty v0.0.3/go.mod h1:M+lRXTBqGeGNdLjl/ufCoiOlB5xdOkqRJdNxMWT7Zi4=
github.com/mattn/go-isatty v0.0.8/go.mod h1:Iq45c/XA43vh69/j3iqttzPXn0bhXyGjM0Hdxcsrc5s=
github.com/mattn/go-isatty v0.0.10/go.mod h1:qgIWMr58cqv1PHHyhnkY9lrL7etaEgOFcMEpPG5Rm84=
github.com/mattn/go-isatty v0.0.12/go.mod h1:cbi8OIDigv2wuxKPP5vlRcQ1OAZbq2CE4Kysco4FUpU=
github.com/mattn/go-isatty v0.0.14 h1:yVuAays6BHfxijgZPzw+3Zlu5yQgKGP2/hcQbHb7S9Y=
github.com/mattn/go-isatty v0.0.14/go.mod h1:7GGIvUiUoEMVVmxf/4nioHXj79iQHKdU27kJ6hsGG94=
+github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM=
+github.com/mattn/go-isatty v0.0.18 h1:DOKFKCQ7FNG2L1rbrmstDN4QVRdS89Nkh85u68Uwp98=
+github.com/mattn/go-isatty v0.0.18/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
github.com/mitchellh/cli v1.1.4 h1:qj8czE26AU4PbiaPXK5uVmMSM+V5BYsFBiM9HhGRLUA=
github.com/mitchellh/cli v1.1.4/go.mod h1:vTLESy5mRhKOs9KDp0/RATawxP1UqBmdrpVRMnpcvKQ=
+github.com/mitchellh/cli v1.1.5 h1:OxRIeJXpAMztws/XHlN2vu6imG5Dpq+j61AzAX5fLng=
+github.com/mitchellh/cli v1.1.5/go.mod h1:v8+iFts2sPIKUV1ltktPXMCC8fumSKFItNcD2cLtRR4=
github.com/mitchellh/copystructure v1.0.0/go.mod h1:SNtv71yrdKgLRyLFxmLdkAbkKEFWgYaq1OVrnRcwhnw=
github.com/mitchellh/copystructure v1.2.0 h1:vpKXTN4ewci03Vljg/q9QvCGUDttBOGBIa15WveJJGw=
github.com/mitchellh/copystructure v1.2.0/go.mod h1:qLl+cE2AmVv+CoeAwDPye/v+N2HKCj9FbZEVFJRxO9s=
@@ -258,6 +306,8 @@ github.com/mitchellh/go-testing-interface v1.14.1/go.mod h1:gfgS7OtZj6MA4U1UrDRp
github.com/mitchellh/go-wordwrap v0.0.0-20150314170334-ad45545899c7/go.mod h1:ZXFpozHsX6DPmq2I0TCekCxypsnAUbP2oI0UX1GXzOo=
github.com/mitchellh/go-wordwrap v1.0.0 h1:6GlHJ/LTGMrIJbwgdqdl2eEH8o+Exx/0m8ir9Gns0u4=
github.com/mitchellh/go-wordwrap v1.0.0/go.mod h1:ZXFpozHsX6DPmq2I0TCekCxypsnAUbP2oI0UX1GXzOo=
+github.com/mitchellh/go-wordwrap v1.0.1 h1:TLuKupo69TCn6TQSyGxwI1EblZZEsQ0vMlAFQflz0v0=
+github.com/mitchellh/go-wordwrap v1.0.1/go.mod h1:R62XHJLzvMFRBbcrT7m7WgmE1eOyTSsCt+hzestvNj0=
github.com/mitchellh/mapstructure v1.5.0 h1:jeMsZIYE/09sWLaz43PL7Gy6RuMjD2eJVyuac5Z2hdY=
github.com/mitchellh/mapstructure v1.5.0/go.mod h1:bFUtVrKA4DC2yAKiSyO/QUcy7e+RRV2QTWOzhPopBRo=
github.com/mitchellh/reflectwalk v1.0.0/go.mod h1:mSTlrgnPZtwu0c4WaC2kGObEpuNDbx0jmZXqmk4esnw=
@@ -272,6 +322,8 @@ github.com/nsf/jsondiff v0.0.0-20200515183724-f29ed568f4ce h1:RPclfga2SEJmgMmz2k
github.com/nsf/jsondiff v0.0.0-20200515183724-f29ed568f4ce/go.mod h1:uFMI8w+ref4v2r9jz+c9i1IfIttS/OkmLfrk1jne5hs=
github.com/oklog/run v1.0.0 h1:Ru7dDtJNOyC66gQ5dQmaCa0qIsAUFY3sFpK1Xk8igrw=
github.com/oklog/run v1.0.0/go.mod h1:dlhp/R75TPv97u0XWUtDeV/lRKWPKSdTuV0TZvrmrQA=
+github.com/oklog/run v1.1.0 h1:GEenZ1cK0+q0+wsJew9qUg/DyD8k3JzYsZAi5gYi2mA=
+github.com/oklog/run v1.1.0/go.mod h1:sVPdnTZT1zYwAJeCMu2Th4T21pA3FPOQRfWjQlk7DVU=
github.com/pkg/diff v0.0.0-20210226163009-20ebb0f2a09e/go.mod h1:pJLUxLENpZxwdsKMEsNbx1VGcRFpLqf3715MtcvvzbA=
github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
@@ -282,6 +334,7 @@ github.com/posener/complete v1.2.3 h1:NP0eAhjcjImqslEwo/1hq7gpajME0fTLTezBKDqfXq
github.com/posener/complete v1.2.3/go.mod h1:WZIdtGGp+qx0sLrYKtIRAruyNpv6hFCicSgv7Sy7s/s=
github.com/prometheus/client_model v0.0.0-20190812154241-14fe0d1b01d4/go.mod h1:xMI15A0UPsDsEKsMN9yxemIoYk6Tm2C1GtYGdfGttqA=
github.com/rogpeppe/fastuuid v1.2.0/go.mod h1:jVj6XXZzXRy/MSR5jhDC/2q6DgLz+nrA6LYCDYWNEvQ=
+github.com/rogpeppe/go-internal v1.6.1 h1:/FiVV8dS/e+YqF2JvO3yXRFbBLTIuSDkuC7aBOAvL+k=
github.com/rogpeppe/go-internal v1.6.1/go.mod h1:xXDCJY+GAPziupqXw64V24skbSoqbTEfhy4qGm1nDQc=
github.com/rogpeppe/go-internal v1.8.0 h1:FCbCCtXNOY3UtUuHUYaghJg4y7Fd14rXifAYUAtL9R8=
github.com/rogpeppe/go-internal v1.8.0/go.mod h1:WmiCO8CzOY8rg0OYDC4/i/2WRWAB6poM+XZ2dLUbcbE=
@@ -300,6 +353,7 @@ github.com/spf13/cast v1.3.1/go.mod h1:Qx5cxh0v+4UWYiBimWS+eyWzqEqokIECu5etghLkU
github.com/spf13/cast v1.5.0 h1:rj3WzYc11XZaIZMPKmwP96zkFEnnAmV8s6XbB2aY32w=
github.com/spf13/cast v1.5.0/go.mod h1:SpXXQ5YoyJw6s3/6cMTQuxvgRl3PCJiyaX9p6b155UU=
github.com/spf13/pflag v1.0.2/go.mod h1:DYY7MBk1bdzusC3SYhjObp+wFpr4gzcvqqNjLnInEg4=
+github.com/spkg/bom v0.0.0-20160624110644-59b7046e48ad/go.mod h1:qLr4V1qq6nMqFKkMo8ZTx3f+BZEkzsRUY10Xsm2mwU0=
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
github.com/stretchr/objx v0.1.1/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
@@ -311,13 +365,18 @@ github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/
github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
github.com/stretchr/testify v1.7.2 h1:4jaiDzPyXQvSd7D0EjG45355tLlV3VOECpq10pLC+8s=
github.com/stretchr/testify v1.7.2/go.mod h1:R6va5+xMeoiuVRoj+gSkQ7d3FALtqAAGI1FQKckRals=
+github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk=
github.com/tidwall/gjson v1.14.1/go.mod h1:/wbyibRr2FHMks5tjHJ5F8dMZh3AcwJEMf5vlfC0lxk=
github.com/tidwall/gjson v1.14.3 h1:9jvXn7olKEHU1S9vwoMGliaT8jq1vJ7IH/n9zD9Dnlw=
github.com/tidwall/gjson v1.14.3/go.mod h1:/wbyibRr2FHMks5tjHJ5F8dMZh3AcwJEMf5vlfC0lxk=
+github.com/tidwall/gjson v1.14.4 h1:uo0p8EbA09J7RQaflQ1aBRffTR7xedD2bcIVSYxLnkM=
+github.com/tidwall/gjson v1.14.4/go.mod h1:/wbyibRr2FHMks5tjHJ5F8dMZh3AcwJEMf5vlfC0lxk=
github.com/tidwall/match v1.1.1 h1:+Ho715JplO36QYgwN9PGYNhgZvoUSc9X2c80KVTi+GA=
github.com/tidwall/match v1.1.1/go.mod h1:eRSPERbgtNPcGhD8UCthc6PmLEQXEWd3PRB5JTxsfmM=
github.com/tidwall/pretty v1.2.0 h1:RWIZEg2iJ8/g6fDDYzMpobmaoGh5OLl4AXtGUGPcqCs=
github.com/tidwall/pretty v1.2.0/go.mod h1:ITEVvHYasfjBbM0u2Pg8T2nJnzm8xPwvNhhsoaGGjNU=
+github.com/tidwall/pretty v1.2.1 h1:qjsOFOWWQl+N3RsoF5/ssm1pHmJJwhjlSbZ51I6wMl4=
+github.com/tidwall/pretty v1.2.1/go.mod h1:ITEVvHYasfjBbM0u2Pg8T2nJnzm8xPwvNhhsoaGGjNU=
github.com/ugorji/go v1.1.7/go.mod h1:kZn38zHttfInRq0xu/PH0az30d+z6vm202qpg1oXVMw=
github.com/ugorji/go v1.2.7/go.mod h1:nF9osbDWLy6bDVv/Rtoh6QgnvNDpmCalQV5urGCCS6M=
github.com/ugorji/go/codec v1.1.7/go.mod h1:Ax+UKWsSmolVDwsd+7N3ZtXu+yMGCf907BLYF3GoBXY=
@@ -331,15 +390,20 @@ github.com/vmihailenco/msgpack/v4 v4.3.12 h1:07s4sz9IReOgdikxLTKNbBdqDMLsjPKXwvC
github.com/vmihailenco/msgpack/v4 v4.3.12/go.mod h1:gborTTJjAo/GWTqqRjrLCn9pgNN+NXzzngzBKDPIqw4=
github.com/vmihailenco/tagparser v0.1.1 h1:quXMXlA39OCbd2wAdTsGDlK9RkOk6Wuw+x37wVyIuWY=
github.com/vmihailenco/tagparser v0.1.1/go.mod h1:OeAg3pn3UbLjkWt+rN9oFYB6u/cQgqMEUPoW2WPyhdI=
+github.com/vmihailenco/tagparser v0.1.2 h1:gnjoVuB/kljJ5wICEEOpx98oXMWPLj22G67Vbd1qPqc=
+github.com/vmihailenco/tagparser v0.1.2/go.mod h1:OeAg3pn3UbLjkWt+rN9oFYB6u/cQgqMEUPoW2WPyhdI=
github.com/xanzy/ssh-agent v0.3.0 h1:wUMzuKtKilRgBAD1sUb8gOwwRr2FGoBVumcjoOACClI=
github.com/xanzy/ssh-agent v0.3.0/go.mod h1:3s9xbODqPuuhK9JV1R321M/FlMZSBvE5aY6eAcqrDh0=
github.com/yuin/goldmark v1.1.32/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
github.com/yuin/goldmark v1.4.1/go.mod h1:mwnBkeHKe2W/ZEtQ+71ViKU8L12m81fl3OWwC1Zlc8k=
+github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY=
github.com/zclconf/go-cty v1.1.0/go.mod h1:xnAOWiHeOqg2nWS62VtQ7pbOu17FtxJNW8RLEih+O3s=
github.com/zclconf/go-cty v1.2.0/go.mod h1:hOPWgoHbaTUnI5k4D2ld+GRpFJSCe6bCM7m1q/N4PQ8=
github.com/zclconf/go-cty v1.8.0/go.mod h1:vVKLxnk3puL4qRAv72AO+W99LUD4da90g3uUAzyuvAk=
github.com/zclconf/go-cty v1.10.0 h1:mp9ZXQeIcN8kAwuqorjH+Q+njbJKjLrvB2yIh4q7U+0=
github.com/zclconf/go-cty v1.10.0/go.mod h1:vVKLxnk3puL4qRAv72AO+W99LUD4da90g3uUAzyuvAk=
+github.com/zclconf/go-cty v1.13.1 h1:0a6bRwuiSHtAmqCqNOE+c2oHgepv0ctoxU4FUe43kwc=
+github.com/zclconf/go-cty v1.13.1/go.mod h1:YKQzy/7pZ7iq2jNFzy5go57xdxdWoLLpaEp4u238AE0=
github.com/zclconf/go-cty-debug v0.0.0-20191215020915-b22d67c1ba0b/go.mod h1:ZRKQfBXbGkpdV6QMzT3rU1kSTAnfu1dO8dPKjYprgj8=
go.opentelemetry.io/proto/otlp v0.7.0/go.mod h1:PqfVotwruBrMGOCsRd/89rSnXhoiJIqeYNgFYFoEGnI=
golang.org/x/crypto v0.0.0-20190219172222-a4c6cb3142f2/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4=
@@ -359,12 +423,19 @@ golang.org/x/crypto v0.0.0-20220411220226-7b82a4e95df4/go.mod h1:IxCIyHEi3zRg3s0
golang.org/x/crypto v0.0.0-20220517005047-85d78b3ac167/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4=
golang.org/x/crypto v0.0.0-20220622213112-05595931fe9d h1:sK3txAijHtOK88l68nt020reeT1ZdKLIYetKl95FzVY=
golang.org/x/crypto v0.0.0-20220622213112-05595931fe9d/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4=
+golang.org/x/crypto v0.5.0/go.mod h1:NK/OQwhpMQP3MwtdjgLlYHnH9ebylxKWv3e0fK+mkQU=
+golang.org/x/crypto v0.7.0 h1:AvwMYaRytfdeVt3u6mLaxYtErKYjxA2OXjJ1HHq6t3A=
+golang.org/x/crypto v0.7.0/go.mod h1:pYwdfH91IfpZVANVyUOhSIPZaFoJGxTFbZhFTx+dXZU=
golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA=
golang.org/x/lint v0.0.0-20181026193005-c67002cb31c3/go.mod h1:UVdnD1Gm6xHRNCYTkRU2/jEulfH38KcIWyp/GAMgvoE=
golang.org/x/lint v0.0.0-20190227174305-5b3e6a55c961/go.mod h1:wehouNa3lNwaWXcvxsM5YxQ5yQlVC4a0KAMCusXpPoU=
golang.org/x/lint v0.0.0-20190313153728-d0100b6bd8b3/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc=
golang.org/x/mod v0.3.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
golang.org/x/mod v0.6.0-dev.0.20220106191415-9b9b3d81d5e3/go.mod h1:3p9vT2HGsQu2K1YbXdKPJLVgG5VJdoTa1poYQBtP1AY=
+golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4=
+golang.org/x/mod v0.7.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs=
+golang.org/x/mod v0.9.0 h1:KENHtAZL2y3NLMYZeHY9DW8HW8V+kQyJsY/V9JlKvCs=
+golang.org/x/mod v0.9.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs=
golang.org/x/net v0.0.0-20180530234432-1e491301e022/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
golang.org/x/net v0.0.0-20180724234803-3673e40ba225/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
golang.org/x/net v0.0.0-20180811021610-c39426892332/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
@@ -387,6 +458,10 @@ golang.org/x/net v0.0.0-20211015210444-4f30a5c0130f/go.mod h1:9nx3DQGgdP8bBQD5qx
golang.org/x/net v0.0.0-20211112202133-69e39bad7dc2/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
golang.org/x/net v0.0.0-20220418201149-a630d4f3e7a2 h1:6mzvA99KwZxbOrxww4EvWVQUnN1+xEu9tafK5ZxkYeA=
golang.org/x/net v0.0.0-20220418201149-a630d4f3e7a2/go.mod h1:CfG3xpIq0wQ8r1q4Su4UZFWDARRcnwPjda9FqA0JpMk=
+golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c=
+golang.org/x/net v0.5.0/go.mod h1:DivGGAXEgPSlEBzxGzZI+ZLohi+xUj054jfeKui00ws=
+golang.org/x/net v0.8.0 h1:Zrh2ngAOFYneWTAIAPethzeaQLuHwhuBkuV6ZiRnUaQ=
+golang.org/x/net v0.8.0/go.mod h1:QVkue5JL9kW//ek3r6jTKnTFis1tRmNAW2P1shuFdJc=
golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U=
golang.org/x/oauth2 v0.0.0-20190604053449-0f29369cfe45/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw=
golang.org/x/oauth2 v0.0.0-20200107190931-bf48bf16ab8d/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw=
@@ -396,6 +471,7 @@ golang.org/x/sync v0.0.0-20181221193216-37e7f081c4d4/go.mod h1:RxMgew5VJxzue5/jJ
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sync v0.0.0-20200625203802-6e8e738ad208/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sync v0.0.0-20210220032951-036812b2e83c/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
+golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sys v0.0.0-20180830151530-49385e6e1522/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
golang.org/x/sys v0.0.0-20180905080454-ebe1bf3edb33/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
@@ -424,10 +500,17 @@ golang.org/x/sys v0.0.0-20211103235746-7861aae1554b/go.mod h1:oPkhp1MJrh7nUepCBc
golang.org/x/sys v0.0.0-20211216021012-1d35b9e2eb4e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.0.0-20220412211240-33da011f77ad/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.0.0-20220503163025-988cb79eb6c6/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.0.0-20220627191245-f75cf1eec38b h1:2n253B2r0pYSmEV+UNCQoPfU/FiaizQEK5Gu4Bq4JE8=
golang.org/x/sys v0.0.0-20220627191245-f75cf1eec38b/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.4.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.6.0 h1:MVltZSvRTcU2ljQOhs94SXPftV6DCNnZViHeQps87pQ=
+golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
+golang.org/x/term v0.4.0/go.mod h1:9P2UbLfCdcvo3p/nzKvsmas4TnlujnuoV9hGgYzW1lQ=
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk=
golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
@@ -435,6 +518,9 @@ golang.org/x/text v0.3.5/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
golang.org/x/text v0.3.7 h1:olpwvP2KacW1ZWvsR7uQhoyTYvKAupfQrRGBFM352Gk=
golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
+golang.org/x/text v0.6.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8=
+golang.org/x/text v0.8.0 h1:57P1ETyNKtuIjB4SRd15iJxuhj8Gc416Y78H3qgMh68=
+golang.org/x/text v0.8.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8=
golang.org/x/time v0.0.0-20201208040808-7e3f01d25324/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=
golang.org/x/time v0.0.0-20220411224347-583f2d630306/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=
golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
@@ -445,6 +531,7 @@ golang.org/x/tools v0.0.0-20190524140312-2c0ae7006135/go.mod h1:RgjU9mgBXZiqYHBn
golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
golang.org/x/tools v0.0.0-20200713011307-fd294ab11aed/go.mod h1:njjCfa9FT2d7l9Bc6FUM5FLjQPp3cFF28FI3qnDFljA=
golang.org/x/tools v0.1.10/go.mod h1:Uh6Zz+xoGYZom868N8YTex3t7RhtHDBrE8Gzo9bV56E=
+golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc=
golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
@@ -455,6 +542,8 @@ google.golang.org/appengine v1.4.0/go.mod h1:xpcJRLb0r/rnEns0DIKYYv+WjYCduHsrkT7
google.golang.org/appengine v1.6.5/go.mod h1:8WjMMxjGQR8xUklV/ARdw2HLXBOI7O7uCIDZVag1xfc=
google.golang.org/appengine v1.6.6 h1:lMO5rYAqUxkmaj76jAkRUvt5JZgFymx/+Q5Mzfivuhc=
google.golang.org/appengine v1.6.6/go.mod h1:8WjMMxjGQR8xUklV/ARdw2HLXBOI7O7uCIDZVag1xfc=
+google.golang.org/appengine v1.6.7 h1:FZR1q0exgwxzPzp/aF+VccGrSfxfPpkBqjIIEq3ru6c=
+google.golang.org/appengine v1.6.7/go.mod h1:8WjMMxjGQR8xUklV/ARdw2HLXBOI7O7uCIDZVag1xfc=
google.golang.org/genproto v0.0.0-20170818010345-ee236bd376b0/go.mod h1:JiN7NxoALGmiZfu7CAH4rXhgtRTLTxftemlI0sWmxmc=
google.golang.org/genproto v0.0.0-20180817151627-c66870c02cf8/go.mod h1:JiN7NxoALGmiZfu7CAH4rXhgtRTLTxftemlI0sWmxmc=
google.golang.org/genproto v0.0.0-20190819201941-24fa4b261c55/go.mod h1:DMBHOl98Agz4BDEuKkezgsaosCRResVns1a3J2ZsMNc=
@@ -462,6 +551,8 @@ google.golang.org/genproto v0.0.0-20200513103714-09dca8ec2884/go.mod h1:55QSHmfG
google.golang.org/genproto v0.0.0-20200526211855-cb27e3aa2013/go.mod h1:NbSheEEYHJ7i3ixzK3sjbqSGDJWnxyFXZblF3eUsNvo=
google.golang.org/genproto v0.0.0-20200711021454-869866162049 h1:YFTFpQhgvrLrmxtiIncJxFXeCyq84ixuKWVCaCAi9Oc=
google.golang.org/genproto v0.0.0-20200711021454-869866162049/go.mod h1:FWY/as6DDZQgahTzZj3fqbO1CbirC29ZNUFHwi0/+no=
+google.golang.org/genproto v0.0.0-20230323212658-478b75c54725 h1:VmCWItVXcKboEMCwZaWge+1JLiTCQSngZeINF+wzO+g=
+google.golang.org/genproto v0.0.0-20230323212658-478b75c54725/go.mod h1:UUQDJDOlWu4KYeJZffbWgBkS1YFobzKbLVfK69pe0Ak=
google.golang.org/grpc v1.8.0/go.mod h1:yo6s7OP7yaDglbqo1J04qKzAhqBH6lvTonzMVmEdcZw=
google.golang.org/grpc v1.19.0/go.mod h1:mqu4LbDTu4XGKhr4mRzUsmM4RtVoemTSY81AxZiDr8c=
google.golang.org/grpc v1.23.0/go.mod h1:Y5yQAOtifL1yxbo5wqy6BxZv8vAUGQwXBOALyacEbxg=
@@ -472,6 +563,8 @@ google.golang.org/grpc v1.33.1/go.mod h1:fr5YgcSWrqhRRxogOsw7RzIpsmvOZ6IcH4kBYTp
google.golang.org/grpc v1.36.0/go.mod h1:qjiiYl8FncCW8feJPdyg3v6XW24KsRHe+dy9BAGRRjU=
google.golang.org/grpc v1.48.0 h1:rQOsyJ/8+ufEDJd/Gdsz7HG220Mh9HAhFHRGnIjda0w=
google.golang.org/grpc v1.48.0/go.mod h1:vN9eftEi1UMyUsIF80+uQXhHjbXYbm0uXoFCACuMGWk=
+google.golang.org/grpc v1.54.0 h1:EhTqbhiYeixwWQtAEZAxmV9MGqcjEU2mFx52xCzNyag=
+google.golang.org/grpc v1.54.0/go.mod h1:PUSEXI6iWghWaB6lXM4knEgpJNu2qUcKfDtNci3EC2g=
google.golang.org/grpc/cmd/protoc-gen-go-grpc v1.2.0/go.mod h1:DNq5QpG7LJqD2AamLZ7zvKE0DEpVl2BSEVjFycAAjRY=
google.golang.org/protobuf v0.0.0-20200109180630-ec00e32a8dfd/go.mod h1:DFci5gLYBciE7Vtevhsrf46CRTquxDuWsQurQQe4oz8=
google.golang.org/protobuf v0.0.0-20200221191635-4d8936d0db64/go.mod h1:kwYJMbMJ01Woi6D6+Kah6886xMZcty6N08ah7+eCXa0=
@@ -488,6 +581,8 @@ google.golang.org/protobuf v1.26.0/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQ
google.golang.org/protobuf v1.27.1/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc=
google.golang.org/protobuf v1.28.0 h1:w43yiav+6bVFTBQFZX0r7ipe9JQ1QsbMgHwbBziscLw=
google.golang.org/protobuf v1.28.0/go.mod h1:HV8QOd/L58Z+nl8r43ehVNZIU/HEI6OcFqwMG9pJV4I=
+google.golang.org/protobuf v1.30.0 h1:kPPoIgf3TsEvrm0PFe15JQ+570QVxYzEvvHqChK+cng=
+google.golang.org/protobuf v1.30.0/go.mod h1:HV8QOd/L58Z+nl8r43ehVNZIU/HEI6OcFqwMG9pJV4I=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
diff --git a/internal/provider/resource_manufacturer.go b/internal/provider/resource_manufacturer.go
index f7d3bbd..3b9ab8a 100644
--- a/internal/provider/resource_manufacturer.go
+++ b/internal/provider/resource_manufacturer.go
@@ -6,6 +6,7 @@ import (
"strings"
"github.com/deepmap/oapi-codegen/pkg/types"
+ "github.com/google/uuid"
"github.com/hashicorp/terraform-plugin-log/tflog"
"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
@@ -169,7 +170,7 @@ func resourceManufacturerRead(ctx context.Context, d *schema.ResourceData, meta
rsp, err := c.DcimManufacturersListWithResponse(
ctx,
&nb.DcimManufacturersListParams{
- IdIe: &[]types.UUID{types.UUID(id)},
+ IdIe: &[]types.UUID{uuid.MustParse(id)},
})
var diags diag.Diagnostics
@@ -260,7 +261,7 @@ func resourceManufacturerUpdate(ctx context.Context, d *schema.ResourceData, met
_, err := c.DcimManufacturersPartialUpdateWithResponse(
ctx,
- types.UUID(id),
+ uuid.MustParse(id),
nb.DcimManufacturersPartialUpdateJSONRequestBody(m))
if err != nil {
return diag.Errorf("failed to update manufacturer %s on %s: %s", name, s, err.Error())
@@ -285,7 +286,7 @@ func resourceManufacturerDelete(ctx context.Context, d *schema.ResourceData, met
_, err := c.DcimManufacturersDestroy(
ctx,
- types.UUID(id))
+ uuid.MustParse(id))
if err != nil {
return diag.Errorf("failed to delete manufacturer %s on %s: %s", name, s, err.Error())
}