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"