Skip to content

Instantly share code, notes, and snippets.

@linkdd
Created November 11, 2024 12:39
Show Gist options
  • Save linkdd/3193453b38357d190545c7988cdac692 to your computer and use it in GitHub Desktop.
Save linkdd/3193453b38357d190545c7988cdac692 to your computer and use it in GitHub Desktop.
Ntbox 3.6.9 OpenAPI + a few plugins
This file has been truncated, but you can view the full file.
{
"openapi": "3.0.3",
"info": {
"title": "NetBox REST API",
"version": "3.6.9 (3.6)",
"license": {
"name": "Apache v2 License"
}
},
"paths": {
"/api/circuits/circuit-terminations/": {
"get": {
"operationId": "circuits_circuit_terminations_list",
"description": "Get a list of circuit termination objects.",
"parameters": [
{
"in": "query",
"name": "cable_end",
"schema": {
"type": "string",
"x-spec-enum-id": "1db84f9b93b261c8"
}
},
{
"in": "query",
"name": "cable_end__n",
"schema": {
"type": "string",
"x-spec-enum-id": "1db84f9b93b261c8"
}
},
{
"in": "query",
"name": "cabled",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "circuit_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Circuit",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "circuit_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Circuit",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "occupied",
"schema": {
"type": "boolean"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "port_speed",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "port_speed__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "port_speed__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "port_speed__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "port_speed__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "port_speed__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "port_speed__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider_network_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "ProviderNetwork (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider_network_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "ProviderNetwork (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "site",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "term_side",
"schema": {
"type": "string",
"x-spec-enum-id": "95b8fcc737f355d0",
"title": "Termination"
}
},
{
"in": "query",
"name": "term_side__n",
"schema": {
"type": "string",
"x-spec-enum-id": "95b8fcc737f355d0",
"title": "Termination"
}
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "upstream_speed",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "upstream_speed__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "upstream_speed__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "upstream_speed__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "upstream_speed__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "upstream_speed__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "upstream_speed__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "xconnect_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "xconnect_id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "xconnect_id__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "xconnect_id__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "xconnect_id__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "xconnect_id__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "xconnect_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "xconnect_id__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "xconnect_id__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "xconnect_id__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "xconnect_id__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedCircuitTerminationList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "circuits_circuit_terminations_create",
"description": "Post a list of circuit termination objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableCircuitTerminationRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableCircuitTerminationRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CircuitTermination"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "circuits_circuit_terminations_bulk_update",
"description": "Put a list of circuit termination objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitTerminationRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitTerminationRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitTermination"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "circuits_circuit_terminations_bulk_partial_update",
"description": "Patch a list of circuit termination objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitTerminationRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitTerminationRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitTermination"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "circuits_circuit_terminations_bulk_destroy",
"description": "Delete a list of circuit termination objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitTerminationRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitTerminationRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/circuits/circuit-terminations/{id}/": {
"get": {
"operationId": "circuits_circuit_terminations_retrieve",
"description": "Get a circuit termination object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this circuit termination.",
"required": true
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CircuitTermination"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "circuits_circuit_terminations_update",
"description": "Put a circuit termination object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this circuit termination.",
"required": true
}
],
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableCircuitTerminationRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableCircuitTerminationRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CircuitTermination"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "circuits_circuit_terminations_partial_update",
"description": "Patch a circuit termination object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this circuit termination.",
"required": true
}
],
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableCircuitTerminationRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableCircuitTerminationRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CircuitTermination"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "circuits_circuit_terminations_destroy",
"description": "Delete a circuit termination object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this circuit termination.",
"required": true
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/circuits/circuit-terminations/{id}/paths/": {
"get": {
"operationId": "circuits_circuit_terminations_paths_retrieve",
"description": "Return all CablePaths which traverse a given pass-through port.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this circuit termination.",
"required": true
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CircuitTermination"
}
}
},
"description": ""
}
}
}
},
"/api/circuits/circuit-types/": {
"get": {
"operationId": "circuits_circuit_types_list",
"description": "Get a list of circuit type objects.",
"parameters": [
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"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"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"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__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedCircuitTypeList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "circuits_circuit_types_create",
"description": "Post a list of circuit type objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CircuitTypeRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/CircuitTypeRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CircuitType"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "circuits_circuit_types_bulk_update",
"description": "Put a list of circuit type objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitTypeRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitTypeRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitType"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "circuits_circuit_types_bulk_partial_update",
"description": "Patch a list of circuit type objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitTypeRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitTypeRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitType"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "circuits_circuit_types_bulk_destroy",
"description": "Delete a list of circuit type objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitTypeRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitTypeRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/circuits/circuit-types/{id}/": {
"get": {
"operationId": "circuits_circuit_types_retrieve",
"description": "Get a circuit type object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this circuit type.",
"required": true
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CircuitType"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "circuits_circuit_types_update",
"description": "Put a circuit type object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this circuit type.",
"required": true
}
],
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CircuitTypeRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/CircuitTypeRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CircuitType"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "circuits_circuit_types_partial_update",
"description": "Patch a circuit type object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this circuit type.",
"required": true
}
],
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedCircuitTypeRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedCircuitTypeRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CircuitType"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "circuits_circuit_types_destroy",
"description": "Delete a circuit type object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this circuit type.",
"required": true
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/circuits/circuits/": {
"get": {
"operationId": "circuits_circuits_list",
"description": "Get a list of circuit objects.",
"parameters": [
{
"in": "query",
"name": "cid",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cid__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "cid__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cid__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cid__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cid__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cid__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cid__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cid__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cid__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cid__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "commit_rate",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "commit_rate__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "commit_rate__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "commit_rate__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "commit_rate__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "commit_rate__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "commit_rate__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact group",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact group",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "install_date",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "install_date__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "install_date__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "install_date__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "install_date__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "install_date__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "install_date__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "provider",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Provider (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Provider (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider_account_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "ProviderAccount (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider_account_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "ProviderAccount (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Provider (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Provider (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider_network_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "ProviderNetwork (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider_network_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "ProviderNetwork (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "region",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Region (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Region (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Region (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Region (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site group (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site group (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site group (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site group (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "63c838134a022200"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "63c838134a022200"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Tenant Group (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Tenant Group (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Tenant Group (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Tenant Group (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "termination_date",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "termination_date__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "termination_date__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "termination_date__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "termination_date__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "termination_date__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "termination_date__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Circuit type (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Circuit type (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Circuit type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Circuit type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedCircuitList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "circuits_circuits_create",
"description": "Post a list of circuit objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableCircuitRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableCircuitRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Circuit"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "circuits_circuits_bulk_update",
"description": "Put a list of circuit objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Circuit"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "circuits_circuits_bulk_partial_update",
"description": "Patch a list of circuit objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Circuit"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "circuits_circuits_bulk_destroy",
"description": "Delete a list of circuit objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/circuits/circuits/{id}/": {
"get": {
"operationId": "circuits_circuits_retrieve",
"description": "Get a circuit object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this circuit.",
"required": true
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Circuit"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "circuits_circuits_update",
"description": "Put a circuit object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this circuit.",
"required": true
}
],
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableCircuitRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableCircuitRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Circuit"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "circuits_circuits_partial_update",
"description": "Patch a circuit object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this circuit.",
"required": true
}
],
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableCircuitRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableCircuitRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Circuit"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "circuits_circuits_destroy",
"description": "Delete a circuit object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this circuit.",
"required": true
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/circuits/provider-accounts/": {
"get": {
"operationId": "circuits_provider_accounts_list",
"description": "Get a list of provider account objects.",
"parameters": [
{
"in": "query",
"name": "account",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "account__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "account__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "account__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "account__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "account__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "account__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "account__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "account__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "account__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "account__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"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"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "provider",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Provider (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Provider (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Provider (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Provider (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedProviderAccountList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "circuits_provider_accounts_create",
"description": "Post a list of provider account objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableProviderAccountRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableProviderAccountRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProviderAccount"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "circuits_provider_accounts_bulk_update",
"description": "Put a list of provider account objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderAccountRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderAccountRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderAccount"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "circuits_provider_accounts_bulk_partial_update",
"description": "Patch a list of provider account objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderAccountRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderAccountRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderAccount"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "circuits_provider_accounts_bulk_destroy",
"description": "Delete a list of provider account objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderAccountRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderAccountRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/circuits/provider-accounts/{id}/": {
"get": {
"operationId": "circuits_provider_accounts_retrieve",
"description": "Get a provider account object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this provider account.",
"required": true
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProviderAccount"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "circuits_provider_accounts_update",
"description": "Put a provider account object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this provider account.",
"required": true
}
],
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableProviderAccountRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableProviderAccountRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProviderAccount"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "circuits_provider_accounts_partial_update",
"description": "Patch a provider account object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this provider account.",
"required": true
}
],
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableProviderAccountRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableProviderAccountRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProviderAccount"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "circuits_provider_accounts_destroy",
"description": "Delete a provider account object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this provider account.",
"required": true
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/circuits/provider-networks/": {
"get": {
"operationId": "circuits_provider_networks_list",
"description": "Get a list of provider network objects.",
"parameters": [
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"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"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "provider",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Provider (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Provider (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Provider (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Provider (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "service_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "service_id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "service_id__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "service_id__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "service_id__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "service_id__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "service_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "service_id__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "service_id__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "service_id__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "service_id__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedProviderNetworkList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "circuits_provider_networks_create",
"description": "Post a list of provider network objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableProviderNetworkRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableProviderNetworkRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProviderNetwork"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "circuits_provider_networks_bulk_update",
"description": "Put a list of provider network objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderNetworkRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderNetworkRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderNetwork"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "circuits_provider_networks_bulk_partial_update",
"description": "Patch a list of provider network objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderNetworkRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderNetworkRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderNetwork"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "circuits_provider_networks_bulk_destroy",
"description": "Delete a list of provider network objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderNetworkRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderNetworkRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/circuits/provider-networks/{id}/": {
"get": {
"operationId": "circuits_provider_networks_retrieve",
"description": "Get a provider network object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this provider network.",
"required": true
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProviderNetwork"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "circuits_provider_networks_update",
"description": "Put a provider network object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this provider network.",
"required": true
}
],
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableProviderNetworkRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableProviderNetworkRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProviderNetwork"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "circuits_provider_networks_partial_update",
"description": "Patch a provider network object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this provider network.",
"required": true
}
],
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableProviderNetworkRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableProviderNetworkRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProviderNetwork"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "circuits_provider_networks_destroy",
"description": "Delete a provider network object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this provider network.",
"required": true
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/circuits/providers/": {
"get": {
"operationId": "circuits_providers_list",
"description": "Get a list of provider objects.",
"parameters": [
{
"in": "query",
"name": "asn_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "ASN (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asn_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "ASN (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact group",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact group",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"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"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "region",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Region (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Region (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Region (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Region (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site group (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site group (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site group (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site group (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedProviderList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "circuits_providers_create",
"description": "Post a list of provider objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableProviderRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableProviderRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Provider"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "circuits_providers_bulk_update",
"description": "Put a list of provider objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Provider"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "circuits_providers_bulk_partial_update",
"description": "Patch a list of provider objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Provider"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "circuits_providers_bulk_destroy",
"description": "Delete a list of provider objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/circuits/providers/{id}/": {
"get": {
"operationId": "circuits_providers_retrieve",
"description": "Get a provider object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this provider.",
"required": true
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Provider"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "circuits_providers_update",
"description": "Put a provider object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this provider.",
"required": true
}
],
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableProviderRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableProviderRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Provider"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "circuits_providers_partial_update",
"description": "Patch a provider object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this provider.",
"required": true
}
],
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableProviderRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableProviderRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Provider"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "circuits_providers_destroy",
"description": "Delete a provider object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this provider.",
"required": true
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/core/data-files/": {
"get": {
"operationId": "core_data_files_list",
"description": "Get a list of data file objects.",
"parameters": [
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "hash",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "hash__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "hash__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "hash__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "hash__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "hash__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "hash__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "hash__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "hash__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "hash__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "hash__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "path",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "path__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "path__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "path__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "path__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "path__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "path__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "path__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "path__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "path__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "path__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "size",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "size__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "size__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "size__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "size__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "size__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "size__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "source",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Data source (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "source__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Data source (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "source_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Data source (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "source_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Data source (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"core"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedDataFileList"
}
}
},
"description": ""
}
}
}
},
"/api/core/data-files/{id}/": {
"get": {
"operationId": "core_data_files_retrieve",
"description": "Get a data file object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this data file.",
"required": true
}
],
"tags": [
"core"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataFile"
}
}
},
"description": ""
}
}
}
},
"/api/core/data-sources/": {
"get": {
"operationId": "core_data_sources_list",
"description": "Get a list of data source objects.",
"parameters": [
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "enabled",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"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"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"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": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "570db3f2d4e98ccf"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "570db3f2d4e98ccf"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"core"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedDataSourceList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "core_data_sources_create",
"description": "Post a list of data source objects.",
"tags": [
"core"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableDataSourceRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableDataSourceRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataSource"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "core_data_sources_bulk_update",
"description": "Put a list of data source objects.",
"tags": [
"core"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataSourceRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataSourceRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataSource"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "core_data_sources_bulk_partial_update",
"description": "Patch a list of data source objects.",
"tags": [
"core"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataSourceRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataSourceRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataSource"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "core_data_sources_bulk_destroy",
"description": "Delete a list of data source objects.",
"tags": [
"core"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataSourceRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataSourceRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/core/data-sources/{id}/": {
"get": {
"operationId": "core_data_sources_retrieve",
"description": "Get a data source object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this data source.",
"required": true
}
],
"tags": [
"core"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataSource"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "core_data_sources_update",
"description": "Put a data source object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this data source.",
"required": true
}
],
"tags": [
"core"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableDataSourceRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableDataSourceRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataSource"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "core_data_sources_partial_update",
"description": "Patch a data source object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this data source.",
"required": true
}
],
"tags": [
"core"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableDataSourceRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableDataSourceRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataSource"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "core_data_sources_destroy",
"description": "Delete a data source object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this data source.",
"required": true
}
],
"tags": [
"core"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/core/data-sources/{id}/sync/": {
"post": {
"operationId": "core_data_sources_sync_create",
"description": "Enqueue a job to synchronize the DataSource.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this data source.",
"required": true
}
],
"tags": [
"core"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableDataSourceRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableDataSourceRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataSource"
}
}
},
"description": ""
}
}
}
},
"/api/core/jobs/": {
"get": {
"operationId": "core_jobs_list",
"description": "Retrieve a list of job results",
"parameters": [
{
"in": "query",
"name": "completed",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"in": "query",
"name": "completed__after",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"in": "query",
"name": "completed__before",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"in": "query",
"name": "created",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"in": "query",
"name": "created__after",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"in": "query",
"name": "created__before",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interval",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interval__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "interval__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interval__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interval__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interval__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interval__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"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__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "object_id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_type",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "object_type__n",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "scheduled",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"in": "query",
"name": "scheduled__after",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"in": "query",
"name": "scheduled__before",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"in": "query",
"name": "started",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"in": "query",
"name": "started__after",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"in": "query",
"name": "started__before",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"in": "query",
"name": "status",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e33887d83efcc138"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e33887d83efcc138"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "user",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "user__n",
"schema": {
"type": "integer"
}
}
],
"tags": [
"core"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedJobList"
}
}
},
"description": ""
}
}
}
},
"/api/core/jobs/{id}/": {
"get": {
"operationId": "core_jobs_retrieve",
"description": "Retrieve a list of job results",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this job.",
"required": true
}
],
"tags": [
"core"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Job"
}
}
},
"description": ""
}
}
}
},
"/api/dcim/cable-terminations/": {
"get": {
"operationId": "dcim_cable_terminations_list",
"description": "Get a list of cable termination objects.",
"parameters": [
{
"in": "query",
"name": "cable",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "cable__n",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "cable_end",
"schema": {
"type": "string",
"x-spec-enum-id": "1db84f9b93b261c8",
"title": "End"
}
},
{
"in": "query",
"name": "cable_end__n",
"schema": {
"type": "string",
"x-spec-enum-id": "1db84f9b93b261c8",
"title": "End"
}
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"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"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "termination_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "termination_id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "termination_id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "termination_id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "termination_id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "termination_id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "termination_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "termination_type",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "termination_type__n",
"schema": {
"type": "string"
}
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedCableTerminationList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_cable_terminations_create",
"description": "Post a list of cable termination objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CableTerminationRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/CableTerminationRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CableTermination"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_cable_terminations_bulk_update",
"description": "Put a list of cable termination objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CableTerminationRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CableTerminationRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CableTermination"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_cable_terminations_bulk_partial_update",
"description": "Patch a list of cable termination objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CableTerminationRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CableTerminationRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CableTermination"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_cable_terminations_bulk_destroy",
"description": "Delete a list of cable termination objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CableTerminationRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CableTerminationRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/cable-terminations/{id}/": {
"get": {
"operationId": "dcim_cable_terminations_retrieve",
"description": "Get a cable termination object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this cable termination.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CableTermination"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_cable_terminations_update",
"description": "Put a cable termination object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this cable termination.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CableTerminationRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/CableTerminationRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CableTermination"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_cable_terminations_partial_update",
"description": "Patch a cable termination object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this cable termination.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedCableTerminationRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedCableTerminationRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CableTermination"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_cable_terminations_destroy",
"description": "Delete a cable termination object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this cable termination.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/cables/": {
"get": {
"operationId": "dcim_cables_list",
"description": "Get a list of cable objects.",
"parameters": [
{
"in": "query",
"name": "color",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "length",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "length__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "length__gt",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "length__gte",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "length__lt",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "length__lte",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "length__n",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "length_unit",
"schema": {
"type": "string",
"x-spec-enum-id": "e64ce3a2c5997172"
}
},
{
"in": "query",
"name": "length_unit__n",
"schema": {
"type": "string",
"x-spec-enum-id": "e64ce3a2c5997172"
}
},
{
"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"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "rack",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "fbc2f302c08be50d"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "fbc2f302c08be50d"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Tenant Group (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Tenant Group (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Tenant Group (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Tenant Group (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "termination_a_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "termination_a_type",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "termination_a_type__n",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "termination_b_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "termination_b_type",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "termination_b_type__n",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "type",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e671018e64196f8d"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e671018e64196f8d"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "unterminated",
"schema": {
"type": "boolean"
},
"description": "Unterminated"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedCableList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_cables_create",
"description": "Post a list of cable objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableCableRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableCableRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Cable"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_cables_bulk_update",
"description": "Put a list of cable objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CableRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CableRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Cable"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_cables_bulk_partial_update",
"description": "Patch a list of cable objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CableRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CableRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Cable"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_cables_bulk_destroy",
"description": "Delete a list of cable objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CableRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CableRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/cables/{id}/": {
"get": {
"operationId": "dcim_cables_retrieve",
"description": "Get a cable object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this cable.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Cable"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_cables_update",
"description": "Put a cable object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this cable.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableCableRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableCableRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Cable"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_cables_partial_update",
"description": "Patch a cable object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this cable.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableCableRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableCableRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Cable"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_cables_destroy",
"description": "Delete a cable object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this cable.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/connected-device/": {
"get": {
"operationId": "dcim_connected_device_list",
"description": "This endpoint allows a user to determine what device (if any) is connected to a given peer device and peer\ninterface. This is useful in a situation where a device boots with no configuration, but can detect its neighbors\nvia a protocol such as LLDP. Two query parameters must be included in the request:\n\n* `peer_device`: The name of the peer device\n* `peer_interface`: The name of the peer interface",
"parameters": [
{
"in": "query",
"name": "peer_device",
"schema": {
"type": "string"
},
"description": "The name of the peer device",
"required": true
},
{
"in": "query",
"name": "peer_interface",
"schema": {
"type": "string"
},
"description": "The name of the peer interface",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Device"
}
}
}
},
"description": ""
}
}
}
},
"/api/dcim/console-port-templates/": {
"get": {
"operationId": "dcim_console_port_templates_list",
"description": "Get a list of console port template objects.",
"parameters": [
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "devicetype_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "devicetype_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "moduletype_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Module type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "moduletype_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Module type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"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"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "type",
"schema": {
"type": "string",
"x-spec-enum-id": "c5f7197b7211818a"
}
},
{
"in": "query",
"name": "type__n",
"schema": {
"type": "string",
"x-spec-enum-id": "c5f7197b7211818a"
}
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedConsolePortTemplateList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_console_port_templates_create",
"description": "Post a list of console port template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableConsolePortTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableConsolePortTemplateRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsolePortTemplate"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_console_port_templates_bulk_update",
"description": "Put a list of console port template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsolePortTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsolePortTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsolePortTemplate"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_console_port_templates_bulk_partial_update",
"description": "Patch a list of console port template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsolePortTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsolePortTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsolePortTemplate"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_console_port_templates_bulk_destroy",
"description": "Delete a list of console port template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsolePortTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsolePortTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/console-port-templates/{id}/": {
"get": {
"operationId": "dcim_console_port_templates_retrieve",
"description": "Get a console port template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this console port template.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsolePortTemplate"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_console_port_templates_update",
"description": "Put a console port template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this console port template.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableConsolePortTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableConsolePortTemplateRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsolePortTemplate"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_console_port_templates_partial_update",
"description": "Patch a console port template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this console port template.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableConsolePortTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableConsolePortTemplateRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsolePortTemplate"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_console_port_templates_destroy",
"description": "Delete a console port template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this console port template.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/console-ports/": {
"get": {
"operationId": "dcim_console_ports_list",
"description": "Get a list of console port objects.",
"parameters": [
{
"in": "query",
"name": "cable_end",
"schema": {
"type": "string",
"x-spec-enum-id": "1db84f9b93b261c8"
}
},
{
"in": "query",
"name": "cable_end__n",
"schema": {
"type": "string",
"x-spec-enum-id": "1db84f9b93b261c8"
}
},
{
"in": "query",
"name": "cabled",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "connected",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
},
"description": "Device (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
},
"description": "Device (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device type (model)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device type (model)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"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"
}
},
"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": "integer"
}
},
"description": "Location (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Location (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "module_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Module (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "module_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Module (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "occupied",
"schema": {
"type": "boolean"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "rack",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Rack (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Rack (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Rack (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Rack (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Region (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Region (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Region (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Region (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site name (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site name (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site group (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site group (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site group (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site group (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "c5f7197b7211818a"
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "c5f7197b7211818a"
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "virtual_chassis",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Virtual Chassis",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Virtual Chassis",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual Chassis (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual Chassis (ID)",
"explode": true,
"style": "form"
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedConsolePortList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_console_ports_create",
"description": "Post a list of console port objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableConsolePortRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableConsolePortRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsolePort"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_console_ports_bulk_update",
"description": "Put a list of console port objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsolePortRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsolePortRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsolePort"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_console_ports_bulk_partial_update",
"description": "Patch a list of console port objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsolePortRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsolePortRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsolePort"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_console_ports_bulk_destroy",
"description": "Delete a list of console port objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsolePortRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsolePortRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/console-ports/{id}/": {
"get": {
"operationId": "dcim_console_ports_retrieve",
"description": "Get a console port object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this console port.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsolePort"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_console_ports_update",
"description": "Put a console port object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this console port.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableConsolePortRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableConsolePortRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsolePort"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_console_ports_partial_update",
"description": "Patch a console port object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this console port.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableConsolePortRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableConsolePortRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsolePort"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_console_ports_destroy",
"description": "Delete a console port object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this console port.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/console-ports/{id}/trace/": {
"get": {
"operationId": "dcim_console_ports_trace_retrieve",
"description": "Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this console port.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsolePort"
}
}
},
"description": ""
}
}
}
},
"/api/dcim/console-server-port-templates/": {
"get": {
"operationId": "dcim_console_server_port_templates_list",
"description": "Get a list of console server port template objects.",
"parameters": [
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "devicetype_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "devicetype_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "moduletype_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Module type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "moduletype_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Module type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"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"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "type",
"schema": {
"type": "string",
"x-spec-enum-id": "c5f7197b7211818a"
}
},
{
"in": "query",
"name": "type__n",
"schema": {
"type": "string",
"x-spec-enum-id": "c5f7197b7211818a"
}
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedConsoleServerPortTemplateList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_console_server_port_templates_create",
"description": "Post a list of console server port template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableConsoleServerPortTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableConsoleServerPortTemplateRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsoleServerPortTemplate"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_console_server_port_templates_bulk_update",
"description": "Put a list of console server port template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsoleServerPortTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsoleServerPortTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsoleServerPortTemplate"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_console_server_port_templates_bulk_partial_update",
"description": "Patch a list of console server port template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsoleServerPortTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsoleServerPortTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsoleServerPortTemplate"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_console_server_port_templates_bulk_destroy",
"description": "Delete a list of console server port template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsoleServerPortTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsoleServerPortTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/console-server-port-templates/{id}/": {
"get": {
"operationId": "dcim_console_server_port_templates_retrieve",
"description": "Get a console server port template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this console server port template.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsoleServerPortTemplate"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_console_server_port_templates_update",
"description": "Put a console server port template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this console server port template.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableConsoleServerPortTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableConsoleServerPortTemplateRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsoleServerPortTemplate"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_console_server_port_templates_partial_update",
"description": "Patch a console server port template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this console server port template.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableConsoleServerPortTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableConsoleServerPortTemplateRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsoleServerPortTemplate"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_console_server_port_templates_destroy",
"description": "Delete a console server port template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this console server port template.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/console-server-ports/": {
"get": {
"operationId": "dcim_console_server_ports_list",
"description": "Get a list of console server port objects.",
"parameters": [
{
"in": "query",
"name": "cable_end",
"schema": {
"type": "string",
"x-spec-enum-id": "1db84f9b93b261c8"
}
},
{
"in": "query",
"name": "cable_end__n",
"schema": {
"type": "string",
"x-spec-enum-id": "1db84f9b93b261c8"
}
},
{
"in": "query",
"name": "cabled",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "connected",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
},
"description": "Device (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
},
"description": "Device (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device type (model)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device type (model)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"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"
}
},
"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": "integer"
}
},
"description": "Location (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Location (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "module_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Module (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "module_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Module (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "occupied",
"schema": {
"type": "boolean"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "rack",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Rack (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Rack (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Rack (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Rack (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Region (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Region (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Region (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Region (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site name (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site name (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site group (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site group (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site group (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site group (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "c5f7197b7211818a"
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "c5f7197b7211818a"
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "virtual_chassis",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Virtual Chassis",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Virtual Chassis",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual Chassis (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual Chassis (ID)",
"explode": true,
"style": "form"
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedConsoleServerPortList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_console_server_ports_create",
"description": "Post a list of console server port objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableConsoleServerPortRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableConsoleServerPortRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsoleServerPort"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_console_server_ports_bulk_update",
"description": "Put a list of console server port objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsoleServerPortRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsoleServerPortRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsoleServerPort"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_console_server_ports_bulk_partial_update",
"description": "Patch a list of console server port objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsoleServerPortRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsoleServerPortRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsoleServerPort"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_console_server_ports_bulk_destroy",
"description": "Delete a list of console server port objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsoleServerPortRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsoleServerPortRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/console-server-ports/{id}/": {
"get": {
"operationId": "dcim_console_server_ports_retrieve",
"description": "Get a console server port object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this console server port.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsoleServerPort"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_console_server_ports_update",
"description": "Put a console server port object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this console server port.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableConsoleServerPortRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableConsoleServerPortRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsoleServerPort"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_console_server_ports_partial_update",
"description": "Patch a console server port object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this console server port.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableConsoleServerPortRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableConsoleServerPortRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsoleServerPort"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_console_server_ports_destroy",
"description": "Delete a console server port object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this console server port.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/console-server-ports/{id}/trace/": {
"get": {
"operationId": "dcim_console_server_ports_trace_retrieve",
"description": "Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this console server port.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsoleServerPort"
}
}
},
"description": ""
}
}
}
},
"/api/dcim/device-bay-templates/": {
"get": {
"operationId": "dcim_device_bay_templates_list",
"description": "Get a list of device bay template objects.",
"parameters": [
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "devicetype_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "devicetype_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"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"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedDeviceBayTemplateList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_device_bay_templates_create",
"description": "Post a list of device bay template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableDeviceBayTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableDeviceBayTemplateRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceBayTemplate"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_device_bay_templates_bulk_update",
"description": "Put a list of device bay template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceBayTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceBayTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceBayTemplate"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_device_bay_templates_bulk_partial_update",
"description": "Patch a list of device bay template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceBayTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceBayTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceBayTemplate"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_device_bay_templates_bulk_destroy",
"description": "Delete a list of device bay template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceBayTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceBayTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/device-bay-templates/{id}/": {
"get": {
"operationId": "dcim_device_bay_templates_retrieve",
"description": "Get a device bay template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this device bay template.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceBayTemplate"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_device_bay_templates_update",
"description": "Put a device bay template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this device bay template.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableDeviceBayTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableDeviceBayTemplateRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceBayTemplate"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_device_bay_templates_partial_update",
"description": "Patch a device bay template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this device bay template.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableDeviceBayTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableDeviceBayTemplateRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceBayTemplate"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_device_bay_templates_destroy",
"description": "Delete a device bay template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this device bay template.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/device-bays/": {
"get": {
"operationId": "dcim_device_bays_list",
"description": "Get a list of device bay objects.",
"parameters": [
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
},
"description": "Device (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
},
"description": "Device (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device type (model)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device type (model)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"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"
}
},
"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": "integer"
}
},
"description": "Location (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Location (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"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"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "rack",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Rack (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Rack (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Rack (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Rack (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Region (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Region (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Region (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Region (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site name (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site name (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site group (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site group (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site group (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site group (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "virtual_chassis",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Virtual Chassis",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Virtual Chassis",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual Chassis (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual Chassis (ID)",
"explode": true,
"style": "form"
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedDeviceBayList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_device_bays_create",
"description": "Post a list of device bay objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableDeviceBayRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableDeviceBayRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceBay"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_device_bays_bulk_update",
"description": "Put a list of device bay objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceBayRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceBayRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceBay"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_device_bays_bulk_partial_update",
"description": "Patch a list of device bay objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceBayRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceBayRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceBay"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_device_bays_bulk_destroy",
"description": "Delete a list of device bay objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceBayRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceBayRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/device-bays/{id}/": {
"get": {
"operationId": "dcim_device_bays_retrieve",
"description": "Get a device bay object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this device bay.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceBay"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_device_bays_update",
"description": "Put a device bay object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this device bay.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableDeviceBayRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableDeviceBayRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceBay"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_device_bays_partial_update",
"description": "Patch a device bay object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this device bay.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableDeviceBayRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableDeviceBayRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceBay"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_device_bays_destroy",
"description": "Delete a device bay object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this device bay.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/device-roles/": {
"get": {
"operationId": "dcim_device_roles_list",
"description": "Get a list of device role objects.",
"parameters": [
{
"in": "query",
"name": "color",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "config_template_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Config template (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "config_template_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Config template (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"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"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"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__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "vm_role",
"schema": {
"type": "boolean"
}
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedDeviceRoleList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_device_roles_create",
"description": "Post a list of device role objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableDeviceRoleRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableDeviceRoleRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceRole"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_device_roles_bulk_update",
"description": "Put a list of device role objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceRoleRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceRoleRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceRole"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_device_roles_bulk_partial_update",
"description": "Patch a list of device role objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceRoleRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceRoleRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceRole"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_device_roles_bulk_destroy",
"description": "Delete a list of device role objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceRoleRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceRoleRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/device-roles/{id}/": {
"get": {
"operationId": "dcim_device_roles_retrieve",
"description": "Get a device role object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this device role.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceRole"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_device_roles_update",
"description": "Put a device role object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this device role.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableDeviceRoleRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableDeviceRoleRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceRole"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_device_roles_partial_update",
"description": "Patch a device role object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this device role.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableDeviceRoleRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableDeviceRoleRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceRole"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_device_roles_destroy",
"description": "Delete a device role object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this device role.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/device-types/": {
"get": {
"operationId": "dcim_device_types_list",
"description": "Get a list of device type objects.",
"parameters": [
{
"in": "query",
"name": "airflow",
"schema": {
"type": "string",
"x-spec-enum-id": "58e389e240a5e53d"
}
},
{
"in": "query",
"name": "airflow__n",
"schema": {
"type": "string",
"x-spec-enum-id": "58e389e240a5e53d"
}
},
{
"in": "query",
"name": "console_ports",
"schema": {
"type": "boolean"
},
"description": "Has console ports"
},
{
"in": "query",
"name": "console_server_ports",
"schema": {
"type": "boolean"
},
"description": "Has console server ports"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "default_platform",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Default platform (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "default_platform__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Default platform (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "default_platform_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Default platform (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "default_platform_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Default platform (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_bays",
"schema": {
"type": "boolean"
},
"description": "Has device bays"
},
{
"in": "query",
"name": "has_front_image",
"schema": {
"type": "boolean"
},
"description": "Has a front image"
},
{
"in": "query",
"name": "has_rear_image",
"schema": {
"type": "boolean"
},
"description": "Has a rear image"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interfaces",
"schema": {
"type": "boolean"
},
"description": "Has interfaces"
},
{
"in": "query",
"name": "inventory_items",
"schema": {
"type": "boolean"
},
"description": "Has inventory items"
},
{
"in": "query",
"name": "is_full_depth",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "manufacturer",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Manufacturer (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "manufacturer__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Manufacturer (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "manufacturer_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Manufacturer (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "manufacturer_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Manufacturer (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "module_bays",
"schema": {
"type": "boolean"
},
"description": "Has module bays"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "part_number",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_number__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "part_number__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_number__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_number__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_number__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_number__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_number__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_number__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_number__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_number__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "pass_through_ports",
"schema": {
"type": "boolean"
},
"description": "Has pass-through ports"
},
{
"in": "query",
"name": "power_outlets",
"schema": {
"type": "boolean"
},
"description": "Has power outlets"
},
{
"in": "query",
"name": "power_ports",
"schema": {
"type": "boolean"
},
"description": "Has power ports"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "slug",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "subdevice_role",
"schema": {
"type": "string",
"x-spec-enum-id": "d10d91f690a856c2",
"title": "Parent/child status"
},
"description": "Parent devices house child devices in device bays. Leave blank if this device type is neither a parent nor a child."
},
{
"in": "query",
"name": "subdevice_role__n",
"schema": {
"type": "string",
"x-spec-enum-id": "d10d91f690a856c2",
"title": "Parent/child status"
},
"description": "Parent devices house child devices in device bays. Leave blank if this device type is neither a parent nor a child."
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "u_height",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "u_height__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "u_height__gt",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "u_height__gte",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "u_height__lt",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "u_height__lte",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "u_height__n",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "weight",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "weight__gt",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__gte",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__lt",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__lte",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__n",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight_unit",
"schema": {
"type": "string",
"x-spec-enum-id": "7c1876f422815884"
}
},
{
"in": "query",
"name": "weight_unit__n",
"schema": {
"type": "string",
"x-spec-enum-id": "7c1876f422815884"
}
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedDeviceTypeList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_device_types_create",
"description": "Post a list of device type objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableDeviceTypeRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableDeviceTypeRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceType"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_device_types_bulk_update",
"description": "Put a list of device type objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceTypeRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceTypeRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceType"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_device_types_bulk_partial_update",
"description": "Patch a list of device type objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceTypeRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceTypeRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceType"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_device_types_bulk_destroy",
"description": "Delete a list of device type objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceTypeRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceTypeRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/device-types/{id}/": {
"get": {
"operationId": "dcim_device_types_retrieve",
"description": "Get a device type object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this device type.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceType"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_device_types_update",
"description": "Put a device type object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this device type.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableDeviceTypeRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableDeviceTypeRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceType"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_device_types_partial_update",
"description": "Patch a device type object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this device type.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableDeviceTypeRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableDeviceTypeRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceType"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_device_types_destroy",
"description": "Delete a device type object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this device type.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/devices/": {
"get": {
"operationId": "dcim_devices_list",
"description": "Get a list of device objects.",
"parameters": [
{
"in": "query",
"name": "airflow",
"schema": {
"type": "string",
"x-spec-enum-id": "58e389e240a5e53d"
}
},
{
"in": "query",
"name": "airflow__n",
"schema": {
"type": "string",
"x-spec-enum-id": "58e389e240a5e53d"
}
},
{
"in": "query",
"name": "asset_tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "asset_tag__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cluster_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "VM cluster (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cluster_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "VM cluster (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "config_template_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Config template (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "config_template_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Config template (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "console_ports",
"schema": {
"type": "boolean"
},
"description": "Has console ports"
},
{
"in": "query",
"name": "console_server_ports",
"schema": {
"type": "boolean"
},
"description": "Has console server ports"
},
{
"in": "query",
"name": "contact",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact group",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact group",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_bays",
"schema": {
"type": "boolean"
},
"description": "Has device bays"
},
{
"in": "query",
"name": "device_type",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device type (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device type (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "face",
"schema": {
"type": "string",
"x-spec-enum-id": "d2fb9b3f75158b83",
"title": "Rack face"
}
},
{
"in": "query",
"name": "face__n",
"schema": {
"type": "string",
"x-spec-enum-id": "d2fb9b3f75158b83",
"title": "Rack face"
}
},
{
"in": "query",
"name": "has_oob_ip",
"schema": {
"type": "boolean"
},
"description": "Has an out-of-band IP"
},
{
"in": "query",
"name": "has_primary_ip",
"schema": {
"type": "boolean"
},
"description": "Has a primary IP"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interfaces",
"schema": {
"type": "boolean"
},
"description": "Has interfaces"
},
{
"in": "query",
"name": "is_full_depth",
"schema": {
"type": "boolean"
},
"description": "Is full depth"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "latitude",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "latitude__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "latitude__gt",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "latitude__gte",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "latitude__lt",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "latitude__lte",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "latitude__n",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "local_context_data",
"schema": {
"type": "boolean"
},
"description": "Has local config context data"
},
{
"in": "query",
"name": "location_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Location (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Location (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "longitude",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "longitude__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "longitude__gt",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "longitude__gte",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "longitude__lt",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "longitude__lte",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "longitude__n",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "manufacturer",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Manufacturer (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "manufacturer__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Manufacturer (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "manufacturer_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Manufacturer (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "manufacturer_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Manufacturer (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device model (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device model (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "module_bays",
"schema": {
"type": "boolean"
},
"description": "Has module bays"
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"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": "oob_ip_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "OOB IP (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "oob_ip_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "OOB IP (ID)",
"explode": true,
"style": "form"
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "parent_device_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Parent Device (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "parent_device_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Parent Device (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "pass_through_ports",
"schema": {
"type": "boolean"
},
"description": "Has pass-through ports"
},
{
"in": "query",
"name": "platform",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Platform (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "platform__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Platform (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "platform_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Platform (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "platform_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Platform (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "position",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "position__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "position__gt",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "position__gte",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "position__lt",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "position__lte",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "position__n",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "power_outlets",
"schema": {
"type": "boolean"
},
"description": "Has power outlets"
},
{
"in": "query",
"name": "power_ports",
"schema": {
"type": "boolean"
},
"description": "Has power ports"
},
{
"in": "query",
"name": "primary_ip4_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Primary IPv4 (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "primary_ip4_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Primary IPv4 (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "primary_ip6_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Primary IPv6 (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "primary_ip6_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Primary IPv6 (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "rack_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Rack (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Rack (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Region (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Region (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Region (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"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": "integer"
}
},
"description": "Role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "serial__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site name (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site name (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site group (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site group (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site group (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site group (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Tenant Group (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Tenant Group (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Tenant Group (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Tenant Group (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "vc_position",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vc_position__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "vc_position__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vc_position__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vc_position__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vc_position__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vc_position__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vc_priority",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vc_priority__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "vc_priority__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vc_priority__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vc_priority__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vc_priority__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vc_priority__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual chassis (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual chassis (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis_member",
"schema": {
"type": "boolean"
},
"description": "Is a virtual chassis member"
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedDeviceWithConfigContextList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_devices_create",
"description": "Post a list of device objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableDeviceWithConfigContextRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableDeviceWithConfigContextRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceWithConfigContext"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_devices_bulk_update",
"description": "Put a list of device objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceWithConfigContextRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceWithConfigContextRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceWithConfigContext"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_devices_bulk_partial_update",
"description": "Patch a list of device objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceWithConfigContextRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceWithConfigContextRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceWithConfigContext"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_devices_bulk_destroy",
"description": "Delete a list of device objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceWithConfigContextRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceWithConfigContextRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/devices/{id}/": {
"get": {
"operationId": "dcim_devices_retrieve",
"description": "Get a device object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this device.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceWithConfigContext"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_devices_update",
"description": "Put a device object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this device.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableDeviceWithConfigContextRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableDeviceWithConfigContextRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceWithConfigContext"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_devices_partial_update",
"description": "Patch a device object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this device.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableDeviceWithConfigContextRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableDeviceWithConfigContextRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceWithConfigContext"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_devices_destroy",
"description": "Delete a device object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this device.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/devices/{id}/render-config/": {
"post": {
"operationId": "dcim_devices_render_config_create",
"description": "Resolve and render the preferred ConfigTemplate for this Device.",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"json",
"txt"
]
}
},
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this device.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableDeviceWithConfigContextRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableDeviceWithConfigContextRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceWithConfigContext"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/DeviceWithConfigContext"
}
}
},
"description": ""
}
}
}
},
"/api/dcim/front-port-templates/": {
"get": {
"operationId": "dcim_front_port_templates_list",
"description": "Get a list of front port template objects.",
"parameters": [
{
"in": "query",
"name": "color",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "devicetype_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "devicetype_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "moduletype_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Module type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "moduletype_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Module type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"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"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "type",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0276d1110ada597a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0276d1110ada597a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedFrontPortTemplateList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_front_port_templates_create",
"description": "Post a list of front port template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableFrontPortTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableFrontPortTemplateRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FrontPortTemplate"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_front_port_templates_bulk_update",
"description": "Put a list of front port template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FrontPortTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FrontPortTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FrontPortTemplate"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_front_port_templates_bulk_partial_update",
"description": "Patch a list of front port template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FrontPortTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FrontPortTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FrontPortTemplate"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_front_port_templates_bulk_destroy",
"description": "Delete a list of front port template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FrontPortTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FrontPortTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/front-port-templates/{id}/": {
"get": {
"operationId": "dcim_front_port_templates_retrieve",
"description": "Get a front port template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this front port template.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FrontPortTemplate"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_front_port_templates_update",
"description": "Put a front port template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this front port template.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableFrontPortTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableFrontPortTemplateRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FrontPortTemplate"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_front_port_templates_partial_update",
"description": "Patch a front port template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this front port template.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableFrontPortTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableFrontPortTemplateRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FrontPortTemplate"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_front_port_templates_destroy",
"description": "Delete a front port template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this front port template.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/front-ports/": {
"get": {
"operationId": "dcim_front_ports_list",
"description": "Get a list of front port objects.",
"parameters": [
{
"in": "query",
"name": "cable_end",
"schema": {
"type": "string",
"x-spec-enum-id": "1db84f9b93b261c8"
}
},
{
"in": "query",
"name": "cable_end__n",
"schema": {
"type": "string",
"x-spec-enum-id": "1db84f9b93b261c8"
}
},
{
"in": "query",
"name": "cabled",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "color",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
},
"description": "Device (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
},
"description": "Device (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device type (model)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device type (model)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"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"
}
},
"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": "integer"
}
},
"description": "Location (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Location (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "module_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Module (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "module_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Module (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "occupied",
"schema": {
"type": "boolean"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "rack",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Rack (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Rack (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Rack (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Rack (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Region (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Region (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Region (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Region (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site name (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site name (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site group (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site group (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site group (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site group (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0276d1110ada597a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0276d1110ada597a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "virtual_chassis",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Virtual Chassis",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Virtual Chassis",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual Chassis (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual Chassis (ID)",
"explode": true,
"style": "form"
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedFrontPortList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_front_ports_create",
"description": "Post a list of front port objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableFrontPortRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableFrontPortRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FrontPort"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_front_ports_bulk_update",
"description": "Put a list of front port objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FrontPortRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FrontPortRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FrontPort"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_front_ports_bulk_partial_update",
"description": "Patch a list of front port objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FrontPortRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FrontPortRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FrontPort"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_front_ports_bulk_destroy",
"description": "Delete a list of front port objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FrontPortRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FrontPortRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/front-ports/{id}/": {
"get": {
"operationId": "dcim_front_ports_retrieve",
"description": "Get a front port object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this front port.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FrontPort"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_front_ports_update",
"description": "Put a front port object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this front port.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableFrontPortRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableFrontPortRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FrontPort"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_front_ports_partial_update",
"description": "Patch a front port object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this front port.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableFrontPortRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableFrontPortRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FrontPort"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_front_ports_destroy",
"description": "Delete a front port object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this front port.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/front-ports/{id}/paths/": {
"get": {
"operationId": "dcim_front_ports_paths_retrieve",
"description": "Return all CablePaths which traverse a given pass-through port.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this front port.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FrontPort"
}
}
},
"description": ""
}
}
}
},
"/api/dcim/interface-templates/": {
"get": {
"operationId": "dcim_interface_templates_list",
"description": "Get a list of interface template objects.",
"parameters": [
{
"in": "query",
"name": "bridge_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "bridge_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "devicetype_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "devicetype_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "enabled",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "mgmt_only",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "moduletype_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Module type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "moduletype_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Module type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"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"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "poe_mode",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2f2fe6dcdc7772bd"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_mode__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2f2fe6dcdc7772bd"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_type",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "74bd3be4012f6da9"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_type__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "74bd3be4012f6da9"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "rf_role",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d2772dbea88b0fb1",
"title": "Wireless role"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_role__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d2772dbea88b0fb1",
"title": "Wireless role"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2787c414ccfa93fd"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2787c414ccfa93fd"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedInterfaceTemplateList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_interface_templates_create",
"description": "Post a list of interface template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableInterfaceTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableInterfaceTemplateRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InterfaceTemplate"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_interface_templates_bulk_update",
"description": "Put a list of interface template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InterfaceTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InterfaceTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InterfaceTemplate"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_interface_templates_bulk_partial_update",
"description": "Patch a list of interface template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InterfaceTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InterfaceTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InterfaceTemplate"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_interface_templates_bulk_destroy",
"description": "Delete a list of interface template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InterfaceTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InterfaceTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/interface-templates/{id}/": {
"get": {
"operationId": "dcim_interface_templates_retrieve",
"description": "Get a interface template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this interface template.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InterfaceTemplate"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_interface_templates_update",
"description": "Put a interface template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this interface template.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableInterfaceTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableInterfaceTemplateRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InterfaceTemplate"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_interface_templates_partial_update",
"description": "Patch a interface template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this interface template.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableInterfaceTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableInterfaceTemplateRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InterfaceTemplate"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_interface_templates_destroy",
"description": "Delete a interface template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this interface template.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/interfaces/": {
"get": {
"operationId": "dcim_interfaces_list",
"description": "Get a list of interface objects.",
"parameters": [
{
"in": "query",
"name": "bridge_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Bridged interface (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "bridge_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Bridged interface (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cable_end",
"schema": {
"type": "string",
"x-spec-enum-id": "1db84f9b93b261c8"
}
},
{
"in": "query",
"name": "cable_end__n",
"schema": {
"type": "string",
"x-spec-enum-id": "1db84f9b93b261c8"
}
},
{
"in": "query",
"name": "cabled",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "connected",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
},
"description": "Device (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
},
"description": "Device (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device type (model)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device type (model)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "duplex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "47eab9b1a65a1e21",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "duplex__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "47eab9b1a65a1e21",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "enabled",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "kind",
"schema": {
"type": "string"
},
"description": "Kind of interface"
},
{
"in": "query",
"name": "l2vpn",
"schema": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"format": "int64",
"nullable": true
}
},
"description": "L2VPN",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "l2vpn__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"format": "int64",
"nullable": true
}
},
"description": "L2VPN",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "l2vpn_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "L2VPN (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "l2vpn_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "L2VPN (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "lag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "LAG interface (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "lag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "LAG interface (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"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"
}
},
"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": "integer"
}
},
"description": "Location (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Location (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mgmt_only",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "mode",
"schema": {
"type": "string",
"x-spec-enum-id": "79109bd9dbb73a3c"
},
"description": "IEEE 802.1Q tagging strategy"
},
{
"in": "query",
"name": "mode__n",
"schema": {
"type": "string",
"x-spec-enum-id": "79109bd9dbb73a3c"
},
"description": "IEEE 802.1Q tagging strategy"
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "module_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Module (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "module_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Module (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mtu",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mtu__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "mtu__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mtu__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mtu__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mtu__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mtu__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "occupied",
"schema": {
"type": "boolean"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "parent_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Parent interface (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "parent_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Parent interface (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_mode",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2f2fe6dcdc7772bd"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_mode__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2f2fe6dcdc7772bd"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_type",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "74bd3be4012f6da9"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_type__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "74bd3be4012f6da9"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "rack",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Rack (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Rack (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Rack (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Rack (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Region (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Region (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Region (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Region (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_channel",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "aac33cc237adc8f9",
"title": "Wireless channel"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_channel__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "aac33cc237adc8f9",
"title": "Wireless channel"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_channel_frequency",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_channel_frequency__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "rf_channel_frequency__gt",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_channel_frequency__gte",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_channel_frequency__lt",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_channel_frequency__lte",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_channel_frequency__n",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_channel_width",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_channel_width__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "rf_channel_width__gt",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_channel_width__gte",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_channel_width__lt",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_channel_width__lte",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_channel_width__n",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_role",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d2772dbea88b0fb1",
"title": "Wireless role"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_role__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d2772dbea88b0fb1",
"title": "Wireless role"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site name (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site name (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site group (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site group (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site group (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site group (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "speed",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "speed__empty",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "speed__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "speed__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "speed__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "speed__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "speed__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"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": "tx_power",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tx_power__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "tx_power__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tx_power__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tx_power__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tx_power__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tx_power__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2787c414ccfa93fd"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2787c414ccfa93fd"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "vdc",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Virtual Device Context",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vdc__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Virtual Device Context",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vdc_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual Device Context",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vdc_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual Device Context",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vdc_identifier",
"schema": {
"type": "array",
"items": {
"type": "integer",
"maximum": 32767,
"minimum": 0,
"nullable": true
}
},
"description": "Virtual Device Context (Identifier)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vdc_identifier__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"maximum": 32767,
"minimum": 0,
"nullable": true
}
},
"description": "Virtual Device Context (Identifier)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Virtual Chassis",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Virtual Chassis",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual Chassis (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual Chassis (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis_member",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis_member_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vlan",
"schema": {
"type": "string"
},
"description": "Assigned VID"
},
{
"in": "query",
"name": "vlan_id",
"schema": {
"type": "string"
},
"description": "Assigned VLAN"
},
{
"in": "query",
"name": "vrf",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true,
"title": "Route distinguisher"
}
},
"description": "VRF (RD)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vrf__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true,
"title": "Route distinguisher"
}
},
"description": "VRF (RD)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vrf_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "VRF",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vrf_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "VRF",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "wwn",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "wwn__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "wwn__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "wwn__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "wwn__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "wwn__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "wwn__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "wwn__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "wwn__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "wwn__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedInterfaceList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_interfaces_create",
"description": "Post a list of interface objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableInterfaceRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableInterfaceRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Interface"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_interfaces_bulk_update",
"description": "Put a list of interface objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InterfaceRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InterfaceRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Interface"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_interfaces_bulk_partial_update",
"description": "Patch a list of interface objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InterfaceRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InterfaceRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Interface"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_interfaces_bulk_destroy",
"description": "Delete a list of interface objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InterfaceRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InterfaceRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/interfaces/{id}/": {
"get": {
"operationId": "dcim_interfaces_retrieve",
"description": "Get a interface object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this interface.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Interface"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_interfaces_update",
"description": "Put a interface object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this interface.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableInterfaceRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableInterfaceRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Interface"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_interfaces_partial_update",
"description": "Patch a interface object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this interface.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableInterfaceRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableInterfaceRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Interface"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_interfaces_destroy",
"description": "Delete a interface object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this interface.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/interfaces/{id}/trace/": {
"get": {
"operationId": "dcim_interfaces_trace_retrieve",
"description": "Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this interface.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Interface"
}
}
},
"description": ""
}
}
}
},
"/api/dcim/inventory-item-roles/": {
"get": {
"operationId": "dcim_inventory_item_roles_list",
"description": "Get a list of inventory item role objects.",
"parameters": [
{
"in": "query",
"name": "color",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"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"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"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__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedInventoryItemRoleList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_inventory_item_roles_create",
"description": "Post a list of inventory item role objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InventoryItemRoleRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/InventoryItemRoleRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InventoryItemRole"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_inventory_item_roles_bulk_update",
"description": "Put a list of inventory item role objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InventoryItemRoleRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InventoryItemRoleRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InventoryItemRole"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_inventory_item_roles_bulk_partial_update",
"description": "Patch a list of inventory item role objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InventoryItemRoleRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InventoryItemRoleRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InventoryItemRole"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_inventory_item_roles_bulk_destroy",
"description": "Delete a list of inventory item role objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InventoryItemRoleRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InventoryItemRoleRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/inventory-item-roles/{id}/": {
"get": {
"operationId": "dcim_inventory_item_roles_retrieve",
"description": "Get a inventory item role object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this inventory item role.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InventoryItemRole"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_inventory_item_roles_update",
"description": "Put a inventory item role object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this inventory item role.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InventoryItemRoleRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/InventoryItemRoleRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InventoryItemRole"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_inventory_item_roles_partial_update",
"description": "Patch a inventory item role object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this inventory item role.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedInventoryItemRoleRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedInventoryItemRoleRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InventoryItemRole"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_inventory_item_roles_destroy",
"description": "Delete a inventory item role object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this inventory item role.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/inventory-item-templates/": {
"get": {
"operationId": "dcim_inventory_item_templates_list",
"description": "Get a list of inventory item template objects.",
"parameters": [
{
"in": "query",
"name": "component_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "component_id__empty",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "component_id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "component_id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "component_id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "component_id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "component_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "component_type",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "component_type__n",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "devicetype_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "devicetype_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "manufacturer",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Manufacturer (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "manufacturer__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Manufacturer (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "manufacturer_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Manufacturer (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "manufacturer_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Manufacturer (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"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__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__nisw",
"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"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "parent_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Parent inventory item (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "parent_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Parent inventory item (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "part_id__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_id__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_id__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_id__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_id__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_id__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_id__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_id__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"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": "integer",
"nullable": true
}
},
"description": "Role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedInventoryItemTemplateList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_inventory_item_templates_create",
"description": "Post a list of inventory item template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableInventoryItemTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableInventoryItemTemplateRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InventoryItemTemplate"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_inventory_item_templates_bulk_update",
"description": "Put a list of inventory item template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InventoryItemTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InventoryItemTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InventoryItemTemplate"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_inventory_item_templates_bulk_partial_update",
"description": "Patch a list of inventory item template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InventoryItemTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InventoryItemTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InventoryItemTemplate"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_inventory_item_templates_bulk_destroy",
"description": "Delete a list of inventory item template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InventoryItemTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InventoryItemTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/inventory-item-templates/{id}/": {
"get": {
"operationId": "dcim_inventory_item_templates_retrieve",
"description": "Get a inventory item template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this inventory item template.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InventoryItemTemplate"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_inventory_item_templates_update",
"description": "Put a inventory item template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this inventory item template.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableInventoryItemTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableInventoryItemTemplateRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InventoryItemTemplate"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_inventory_item_templates_partial_update",
"description": "Patch a inventory item template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this inventory item template.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableInventoryItemTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableInventoryItemTemplateRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InventoryItemTemplate"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_inventory_item_templates_destroy",
"description": "Delete a inventory item template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this inventory item template.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/inventory-items/": {
"get": {
"operationId": "dcim_inventory_items_list",
"description": "Get a list of inventory item objects.",
"parameters": [
{
"in": "query",
"name": "asset_tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "asset_tag__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "component_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "component_id__empty",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "component_id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "component_id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "component_id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "component_id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "component_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "component_type",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "component_type__n",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment