NetBox API
API to access NetBox
COMMUNITYAPI KEY0 INSTALLS
OpenAPI Specificationv3.0
{
"openapi": "3.0.0",
"servers": [
{
"url": "https://netboxdemo.com/api"
}
],
"info": {
"description": "API to access NetBox",
"license": {
"name": "Apache v2 License"
},
"termsOfService": "https://github.com/netbox-community/netbox",
"title": "NetBox API",
"version": "2.8",
"x-apisguru-categories": [
"cloud"
],
"x-origin": [
{
"format": "swagger",
"url": "https://netboxdemo.com/api/swagger.json",
"version": "2.0"
}
],
"x-preferred": true,
"x-providerName": "netboxdemo.com",
"x-logo": {
"url": "https://api.apis.guru/v2/cache/logo/https_apis.guru_assets_images_no-logo.svg"
}
},
"security": [
{
"Bearer": []
}
],
"paths": {
"/circuits/circuit-terminations/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "circuits_circuit-terminations_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "term_side",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "port_speed",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "upstream_speed",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "xconnect_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "circuit_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "term_side__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "port_speed__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "port_speed__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "port_speed__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "port_speed__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "port_speed__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "upstream_speed__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "upstream_speed__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "upstream_speed__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "upstream_speed__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "upstream_speed__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "xconnect_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "xconnect_id__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "xconnect_id__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "xconnect_id__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "xconnect_id__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "xconnect_id__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "xconnect_id__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "xconnect_id__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "xconnect_id__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "circuit_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/CircuitTermination"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"circuits"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "circuits_circuit-terminations_create",
"requestBody": {
"$ref": "#/components/requestBodies/WritableCircuitTermination"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CircuitTermination"
}
}
},
"description": ""
}
},
"tags": [
"circuits"
]
}
},
"/circuits/circuit-terminations/{id}/": {
"delete": {
"description": "",
"operationId": "circuits_circuit-terminations_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"circuits"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "circuits_circuit-terminations_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CircuitTermination"
}
}
},
"description": ""
}
},
"tags": [
"circuits"
]
},
"parameters": [
{
"description": "A unique integer value identifying this circuit termination.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "circuits_circuit-terminations_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableCircuitTermination"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CircuitTermination"
}
}
},
"description": ""
}
},
"tags": [
"circuits"
]
},
"put": {
"description": "",
"operationId": "circuits_circuit-terminations_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableCircuitTermination"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CircuitTermination"
}
}
},
"description": ""
}
},
"tags": [
"circuits"
]
}
},
"/circuits/circuit-types/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "circuits_circuit-types_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/CircuitType"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"circuits"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "circuits_circuit-types_create",
"requestBody": {
"$ref": "#/components/requestBodies/CircuitType"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CircuitType"
}
}
},
"description": ""
}
},
"tags": [
"circuits"
]
}
},
"/circuits/circuit-types/{id}/": {
"delete": {
"description": "",
"operationId": "circuits_circuit-types_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"circuits"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "circuits_circuit-types_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CircuitType"
}
}
},
"description": ""
}
},
"tags": [
"circuits"
]
},
"parameters": [
{
"description": "A unique integer value identifying this circuit type.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "circuits_circuit-types_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/CircuitType"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CircuitType"
}
}
},
"description": ""
}
},
"tags": [
"circuits"
]
},
"put": {
"description": "",
"operationId": "circuits_circuit-types_update",
"requestBody": {
"$ref": "#/components/requestBodies/CircuitType"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CircuitType"
}
}
},
"description": ""
}
},
"tags": [
"circuits"
]
}
},
"/circuits/circuits/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "circuits_circuits_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "cid",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "install_date",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "commit_rate",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_group_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_group",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "provider_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "provider",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "type_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "type",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "status",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "cid__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "cid__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "cid__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "cid__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "cid__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "cid__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "cid__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "cid__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "cid__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "install_date__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "install_date__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "install_date__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "install_date__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "install_date__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "commit_rate__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "commit_rate__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "commit_rate__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "commit_rate__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "commit_rate__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_group_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_group__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "provider_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "provider__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "type_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "type__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "status__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/Circuit"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"circuits"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "circuits_circuits_create",
"requestBody": {
"$ref": "#/components/requestBodies/WritableCircuit"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Circuit"
}
}
},
"description": ""
}
},
"tags": [
"circuits"
]
}
},
"/circuits/circuits/{id}/": {
"delete": {
"description": "",
"operationId": "circuits_circuits_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"circuits"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "circuits_circuits_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Circuit"
}
}
},
"description": ""
}
},
"tags": [
"circuits"
]
},
"parameters": [
{
"description": "A unique integer value identifying this circuit.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "circuits_circuits_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableCircuit"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Circuit"
}
}
},
"description": ""
}
},
"tags": [
"circuits"
]
},
"put": {
"description": "",
"operationId": "circuits_circuits_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableCircuit"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Circuit"
}
}
},
"description": ""
}
},
"tags": [
"circuits"
]
}
},
"/circuits/providers/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "circuits_providers_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "asn",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "account",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "asn__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "asn__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "asn__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "asn__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "asn__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "account__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "account__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "account__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "account__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "account__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "account__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "account__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "account__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "account__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/Provider"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"circuits"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "circuits_providers_create",
"requestBody": {
"$ref": "#/components/requestBodies/Provider"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Provider"
}
}
},
"description": ""
}
},
"tags": [
"circuits"
]
}
},
"/circuits/providers/{id}/": {
"delete": {
"description": "",
"operationId": "circuits_providers_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"circuits"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "circuits_providers_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Provider"
}
}
},
"description": ""
}
},
"tags": [
"circuits"
]
},
"parameters": [
{
"description": "A unique integer value identifying this provider.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "circuits_providers_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/Provider"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Provider"
}
}
},
"description": ""
}
},
"tags": [
"circuits"
]
},
"put": {
"description": "",
"operationId": "circuits_providers_update",
"requestBody": {
"$ref": "#/components/requestBodies/Provider"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Provider"
}
}
},
"description": ""
}
},
"tags": [
"circuits"
]
}
},
"/circuits/providers/{id}/graphs/": {
"get": {
"description": "A convenience method for rendering graphs for a particular provider.",
"operationId": "circuits_providers_graphs",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Provider"
}
}
},
"description": ""
}
},
"tags": [
"circuits"
]
},
"parameters": [
{
"description": "A unique integer value identifying this provider.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
]
},
"/dcim/cables/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_cables_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "label",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "length",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "length_unit",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "type",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "status",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "color",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "rack_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "rack",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "label__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "label__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "label__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "label__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "label__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "label__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "label__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "label__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "label__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "length__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "length__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "length__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "length__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "length__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "length_unit__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "type__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "status__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "color__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/Cable"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "dcim_cables_create",
"requestBody": {
"$ref": "#/components/requestBodies/WritableCable"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Cable"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/cables/{id}/": {
"delete": {
"description": "",
"operationId": "dcim_cables_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"dcim"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_cables_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Cable"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [
{
"description": "A unique integer value identifying this cable.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "dcim_cables_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableCable"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Cable"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"put": {
"description": "",
"operationId": "dcim_cables_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableCable"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Cable"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/connected-device/": {
"get": {
"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",
"operationId": "dcim_connected-device_list",
"parameters": [
{
"description": "The name of the peer device",
"in": "query",
"name": "peer_device",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "The name of the peer interface",
"in": "query",
"name": "peer_interface",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Device"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": []
},
"/dcim/console-connections/": {
"get": {
"description": "",
"operationId": "dcim_console-connections_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "connection_status",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "connection_status__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/ConsolePort"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": []
},
"/dcim/console-port-templates/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_console-port-templates_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "type",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "devicetype_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "type__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "devicetype_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/ConsolePortTemplate"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "dcim_console-port-templates_create",
"requestBody": {
"$ref": "#/components/requestBodies/WritableConsolePortTemplate"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsolePortTemplate"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/console-port-templates/{id}/": {
"delete": {
"description": "",
"operationId": "dcim_console-port-templates_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"dcim"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_console-port-templates_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsolePortTemplate"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [
{
"description": "A unique integer value identifying this console port template.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "dcim_console-port-templates_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableConsolePortTemplate"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsolePortTemplate"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"put": {
"description": "",
"operationId": "dcim_console-port-templates_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableConsolePortTemplate"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsolePortTemplate"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/console-ports/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_console-ports_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "connection_status",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "type",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "cabled",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "connection_status__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "type__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/ConsolePort"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "dcim_console-ports_create",
"requestBody": {
"$ref": "#/components/requestBodies/WritableConsolePort"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsolePort"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/console-ports/{id}/": {
"delete": {
"description": "",
"operationId": "dcim_console-ports_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"dcim"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_console-ports_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsolePort"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [
{
"description": "A unique integer value identifying this console port.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "dcim_console-ports_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableConsolePort"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsolePort"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"put": {
"description": "",
"operationId": "dcim_console-ports_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableConsolePort"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsolePort"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/console-ports/{id}/trace/": {
"get": {
"description": "Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).",
"operationId": "dcim_console-ports_trace",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsolePort"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [
{
"description": "A unique integer value identifying this console port.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
]
},
"/dcim/console-server-port-templates/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_console-server-port-templates_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "type",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "devicetype_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "type__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "devicetype_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/ConsoleServerPortTemplate"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "dcim_console-server-port-templates_create",
"requestBody": {
"$ref": "#/components/requestBodies/WritableConsoleServerPortTemplate"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsoleServerPortTemplate"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/console-server-port-templates/{id}/": {
"delete": {
"description": "",
"operationId": "dcim_console-server-port-templates_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"dcim"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_console-server-port-templates_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsoleServerPortTemplate"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [
{
"description": "A unique integer value identifying this console server port template.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "dcim_console-server-port-templates_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableConsoleServerPortTemplate"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsoleServerPortTemplate"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"put": {
"description": "",
"operationId": "dcim_console-server-port-templates_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableConsoleServerPortTemplate"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsoleServerPortTemplate"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/console-server-ports/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_console-server-ports_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "connection_status",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "type",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "cabled",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "connection_status__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "type__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/ConsoleServerPort"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "dcim_console-server-ports_create",
"requestBody": {
"$ref": "#/components/requestBodies/WritableConsoleServerPort"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsoleServerPort"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/console-server-ports/{id}/": {
"delete": {
"description": "",
"operationId": "dcim_console-server-ports_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"dcim"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_console-server-ports_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsoleServerPort"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [
{
"description": "A unique integer value identifying this console server port.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "dcim_console-server-ports_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableConsoleServerPort"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsoleServerPort"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"put": {
"description": "",
"operationId": "dcim_console-server-ports_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableConsoleServerPort"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsoleServerPort"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/console-server-ports/{id}/trace/": {
"get": {
"description": "Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).",
"operationId": "dcim_console-server-ports_trace",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsoleServerPort"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [
{
"description": "A unique integer value identifying this console server port.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
]
},
"/dcim/device-bay-templates/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_device-bay-templates_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "devicetype_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "devicetype_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/DeviceBayTemplate"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "dcim_device-bay-templates_create",
"requestBody": {
"$ref": "#/components/requestBodies/WritableDeviceBayTemplate"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceBayTemplate"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/device-bay-templates/{id}/": {
"delete": {
"description": "",
"operationId": "dcim_device-bay-templates_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"dcim"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_device-bay-templates_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceBayTemplate"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [
{
"description": "A unique integer value identifying this device bay template.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "dcim_device-bay-templates_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableDeviceBayTemplate"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceBayTemplate"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"put": {
"description": "",
"operationId": "dcim_device-bay-templates_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableDeviceBayTemplate"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceBayTemplate"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/device-bays/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_device-bays_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/DeviceBay"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "dcim_device-bays_create",
"requestBody": {
"$ref": "#/components/requestBodies/WritableDeviceBay"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceBay"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/device-bays/{id}/": {
"delete": {
"description": "",
"operationId": "dcim_device-bays_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"dcim"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_device-bays_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceBay"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [
{
"description": "A unique integer value identifying this device bay.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "dcim_device-bays_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableDeviceBay"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceBay"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"put": {
"description": "",
"operationId": "dcim_device-bays_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableDeviceBay"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceBay"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/device-roles/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_device-roles_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "color",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "vm_role",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "color__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "color__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "color__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "color__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "color__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "color__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "color__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "color__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "color__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/DeviceRole"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "dcim_device-roles_create",
"requestBody": {
"$ref": "#/components/requestBodies/DeviceRole"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceRole"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/device-roles/{id}/": {
"delete": {
"description": "",
"operationId": "dcim_device-roles_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"dcim"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_device-roles_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceRole"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [
{
"description": "A unique integer value identifying this device role.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "dcim_device-roles_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/DeviceRole"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceRole"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"put": {
"description": "",
"operationId": "dcim_device-roles_update",
"requestBody": {
"$ref": "#/components/requestBodies/DeviceRole"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceRole"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/device-types/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_device-types_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "model",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "part_number",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "u_height",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "is_full_depth",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "subdevice_role",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "manufacturer_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "manufacturer",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "console_ports",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "console_server_ports",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "power_ports",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "power_outlets",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "interfaces",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "pass_through_ports",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device_bays",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "model__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "model__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "model__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "model__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "model__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "model__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "model__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "model__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "model__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "part_number__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "part_number__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "part_number__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "part_number__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "part_number__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "part_number__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "part_number__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "part_number__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "part_number__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "u_height__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "u_height__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "u_height__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "u_height__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "u_height__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "subdevice_role__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "manufacturer_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "manufacturer__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/DeviceType"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "dcim_device-types_create",
"requestBody": {
"$ref": "#/components/requestBodies/WritableDeviceType"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceType"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/device-types/{id}/": {
"delete": {
"description": "",
"operationId": "dcim_device-types_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"dcim"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_device-types_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceType"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [
{
"description": "A unique integer value identifying this device type.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "dcim_device-types_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableDeviceType"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceType"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"put": {
"description": "",
"operationId": "dcim_device-types_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableDeviceType"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceType"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/devices/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_devices_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "asset_tag",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "face",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "position",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "vc_position",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "vc_priority",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_group_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_group",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "local_context_data",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "manufacturer_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "manufacturer",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device_type_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "role_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "role",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "platform_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "platform",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "rack_group_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "rack_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "cluster_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "model",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "status",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "is_full_depth",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mac_address",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "serial",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "has_primary_ip",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "virtual_chassis_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "virtual_chassis_member",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "console_ports",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "console_server_ports",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "power_ports",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "power_outlets",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "interfaces",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "pass_through_ports",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device_bays",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "asset_tag__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "asset_tag__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "asset_tag__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "asset_tag__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "asset_tag__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "asset_tag__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "asset_tag__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "asset_tag__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "asset_tag__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "face__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "position__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "position__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "position__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "position__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "position__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "vc_position__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "vc_position__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "vc_position__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "vc_position__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "vc_position__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "vc_priority__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "vc_priority__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "vc_priority__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "vc_priority__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "vc_priority__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_group_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_group__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "manufacturer_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "manufacturer__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device_type_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "role_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "role__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "platform_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "platform__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "rack_group_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "rack_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "cluster_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "model__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "status__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mac_address__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mac_address__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mac_address__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mac_address__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mac_address__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mac_address__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mac_address__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mac_address__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mac_address__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "virtual_chassis_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/DeviceWithConfigContext"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "dcim_devices_create",
"requestBody": {
"$ref": "#/components/requestBodies/WritableDeviceWithConfigContext"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceWithConfigContext"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/devices/{id}/": {
"delete": {
"description": "",
"operationId": "dcim_devices_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"dcim"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_devices_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceWithConfigContext"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [
{
"description": "A unique integer value identifying this device.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "dcim_devices_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableDeviceWithConfigContext"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceWithConfigContext"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"put": {
"description": "",
"operationId": "dcim_devices_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableDeviceWithConfigContext"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceWithConfigContext"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/devices/{id}/graphs/": {
"get": {
"description": "A convenience method for rendering graphs for a particular Device.",
"operationId": "dcim_devices_graphs",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceWithConfigContext"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [
{
"description": "A unique integer value identifying this device.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
]
},
"/dcim/devices/{id}/napalm/": {
"get": {
"description": "Execute a NAPALM method on a Device",
"operationId": "dcim_devices_napalm",
"parameters": [
{
"in": "query",
"name": "method",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceNAPALM"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [
{
"description": "A unique integer value identifying this device.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
]
},
"/dcim/front-port-templates/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_front-port-templates_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "type",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "devicetype_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "type__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "devicetype_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/FrontPortTemplate"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "dcim_front-port-templates_create",
"requestBody": {
"$ref": "#/components/requestBodies/WritableFrontPortTemplate"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FrontPortTemplate"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/front-port-templates/{id}/": {
"delete": {
"description": "",
"operationId": "dcim_front-port-templates_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"dcim"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_front-port-templates_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FrontPortTemplate"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [
{
"description": "A unique integer value identifying this front port template.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "dcim_front-port-templates_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableFrontPortTemplate"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FrontPortTemplate"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"put": {
"description": "",
"operationId": "dcim_front-port-templates_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableFrontPortTemplate"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FrontPortTemplate"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/front-ports/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_front-ports_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "type",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "cabled",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "type__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/FrontPort"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "dcim_front-ports_create",
"requestBody": {
"$ref": "#/components/requestBodies/WritableFrontPort"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FrontPort"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/front-ports/{id}/": {
"delete": {
"description": "",
"operationId": "dcim_front-ports_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"dcim"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_front-ports_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FrontPort"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [
{
"description": "A unique integer value identifying this front port.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "dcim_front-ports_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableFrontPort"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FrontPort"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"put": {
"description": "",
"operationId": "dcim_front-ports_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableFrontPort"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FrontPort"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/front-ports/{id}/trace/": {
"get": {
"description": "Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).",
"operationId": "dcim_front-ports_trace",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FrontPort"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [
{
"description": "A unique integer value identifying this front port.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
]
},
"/dcim/interface-connections/": {
"get": {
"description": "",
"operationId": "dcim_interface-connections_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "connection_status",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "connection_status__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/InterfaceConnection"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": []
},
"/dcim/interface-templates/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_interface-templates_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "type",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mgmt_only",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "devicetype_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "type__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "devicetype_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/InterfaceTemplate"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "dcim_interface-templates_create",
"requestBody": {
"$ref": "#/components/requestBodies/WritableInterfaceTemplate"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InterfaceTemplate"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/interface-templates/{id}/": {
"delete": {
"description": "",
"operationId": "dcim_interface-templates_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"dcim"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_interface-templates_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InterfaceTemplate"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [
{
"description": "A unique integer value identifying this interface template.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "dcim_interface-templates_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableInterfaceTemplate"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InterfaceTemplate"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"put": {
"description": "",
"operationId": "dcim_interface-templates_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableInterfaceTemplate"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InterfaceTemplate"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/interfaces/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_interfaces_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "connection_status",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "type",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "enabled",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mtu",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mgmt_only",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mode",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "cabled",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "kind",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "lag_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mac_address",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "vlan_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "vlan",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "connection_status__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "type__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mtu__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mtu__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mtu__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mtu__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mtu__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mode__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "lag_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mac_address__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mac_address__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mac_address__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mac_address__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mac_address__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mac_address__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mac_address__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mac_address__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mac_address__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/DeviceInterface"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "dcim_interfaces_create",
"requestBody": {
"$ref": "#/components/requestBodies/WritableDeviceInterface"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceInterface"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/interfaces/{id}/": {
"delete": {
"description": "",
"operationId": "dcim_interfaces_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"dcim"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_interfaces_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceInterface"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [
{
"description": "A unique integer value identifying this interface.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "dcim_interfaces_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableDeviceInterface"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceInterface"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"put": {
"description": "",
"operationId": "dcim_interfaces_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableDeviceInterface"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceInterface"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/interfaces/{id}/graphs/": {
"get": {
"description": "A convenience method for rendering graphs for a particular interface.",
"operationId": "dcim_interfaces_graphs",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceInterface"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [
{
"description": "A unique integer value identifying this interface.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
]
},
"/dcim/interfaces/{id}/trace/": {
"get": {
"description": "Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).",
"operationId": "dcim_interfaces_trace",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceInterface"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [
{
"description": "A unique integer value identifying this interface.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
]
},
"/dcim/inventory-items/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_inventory-items_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "part_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "asset_tag",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "discovered",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "parent_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "manufacturer_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "manufacturer",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "serial",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "part_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "part_id__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "part_id__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "part_id__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "part_id__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "part_id__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "part_id__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "part_id__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "part_id__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "asset_tag__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "asset_tag__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "asset_tag__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "asset_tag__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "asset_tag__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "asset_tag__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "asset_tag__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "asset_tag__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "asset_tag__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "parent_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "manufacturer_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "manufacturer__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/InventoryItem"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "dcim_inventory-items_create",
"requestBody": {
"$ref": "#/components/requestBodies/WritableInventoryItem"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InventoryItem"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/inventory-items/{id}/": {
"delete": {
"description": "",
"operationId": "dcim_inventory-items_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"dcim"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_inventory-items_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InventoryItem"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [
{
"description": "A unique integer value identifying this inventory item.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "dcim_inventory-items_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableInventoryItem"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InventoryItem"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"put": {
"description": "",
"operationId": "dcim_inventory-items_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableInventoryItem"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InventoryItem"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/manufacturers/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_manufacturers_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/Manufacturer"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "dcim_manufacturers_create",
"requestBody": {
"$ref": "#/components/requestBodies/Manufacturer"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Manufacturer"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/manufacturers/{id}/": {
"delete": {
"description": "",
"operationId": "dcim_manufacturers_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"dcim"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_manufacturers_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Manufacturer"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [
{
"description": "A unique integer value identifying this manufacturer.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "dcim_manufacturers_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/Manufacturer"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Manufacturer"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"put": {
"description": "",
"operationId": "dcim_manufacturers_update",
"requestBody": {
"$ref": "#/components/requestBodies/Manufacturer"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Manufacturer"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/platforms/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_platforms_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "napalm_driver",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "manufacturer_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "manufacturer",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "napalm_driver__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "napalm_driver__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "napalm_driver__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "napalm_driver__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "napalm_driver__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "napalm_driver__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "napalm_driver__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "napalm_driver__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "napalm_driver__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "manufacturer_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "manufacturer__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/Platform"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "dcim_platforms_create",
"requestBody": {
"$ref": "#/components/requestBodies/WritablePlatform"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Platform"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/platforms/{id}/": {
"delete": {
"description": "",
"operationId": "dcim_platforms_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"dcim"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_platforms_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Platform"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [
{
"description": "A unique integer value identifying this platform.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "dcim_platforms_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritablePlatform"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Platform"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"put": {
"description": "",
"operationId": "dcim_platforms_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritablePlatform"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Platform"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/power-connections/": {
"get": {
"description": "",
"operationId": "dcim_power-connections_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "connection_status",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "connection_status__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/PowerPort"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": []
},
"/dcim/power-feeds/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_power-feeds_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "status",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "type",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "supply",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "phase",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "voltage",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "amperage",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "max_utilization",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "power_panel_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "rack_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "status__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "type__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "supply__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "phase__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "voltage__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "voltage__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "voltage__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "voltage__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "voltage__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "amperage__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "amperage__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "amperage__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "amperage__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "amperage__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "max_utilization__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "max_utilization__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "max_utilization__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "max_utilization__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "max_utilization__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "power_panel_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "rack_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/PowerFeed"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "dcim_power-feeds_create",
"requestBody": {
"$ref": "#/components/requestBodies/WritablePowerFeed"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerFeed"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/power-feeds/{id}/": {
"delete": {
"description": "",
"operationId": "dcim_power-feeds_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"dcim"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_power-feeds_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerFeed"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [
{
"description": "A unique integer value identifying this power feed.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "dcim_power-feeds_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritablePowerFeed"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerFeed"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"put": {
"description": "",
"operationId": "dcim_power-feeds_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritablePowerFeed"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerFeed"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/power-outlet-templates/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_power-outlet-templates_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "type",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "feed_leg",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "devicetype_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "type__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "feed_leg__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "devicetype_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/PowerOutletTemplate"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "dcim_power-outlet-templates_create",
"requestBody": {
"$ref": "#/components/requestBodies/WritablePowerOutletTemplate"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerOutletTemplate"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/power-outlet-templates/{id}/": {
"delete": {
"description": "",
"operationId": "dcim_power-outlet-templates_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"dcim"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_power-outlet-templates_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerOutletTemplate"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [
{
"description": "A unique integer value identifying this power outlet template.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "dcim_power-outlet-templates_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritablePowerOutletTemplate"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerOutletTemplate"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"put": {
"description": "",
"operationId": "dcim_power-outlet-templates_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritablePowerOutletTemplate"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerOutletTemplate"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/power-outlets/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_power-outlets_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "feed_leg",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "connection_status",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "type",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "cabled",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "feed_leg__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "connection_status__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "type__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/PowerOutlet"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "dcim_power-outlets_create",
"requestBody": {
"$ref": "#/components/requestBodies/WritablePowerOutlet"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerOutlet"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/power-outlets/{id}/": {
"delete": {
"description": "",
"operationId": "dcim_power-outlets_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"dcim"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_power-outlets_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerOutlet"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [
{
"description": "A unique integer value identifying this power outlet.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "dcim_power-outlets_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritablePowerOutlet"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerOutlet"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"put": {
"description": "",
"operationId": "dcim_power-outlets_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritablePowerOutlet"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerOutlet"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/power-outlets/{id}/trace/": {
"get": {
"description": "Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).",
"operationId": "dcim_power-outlets_trace",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerOutlet"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [
{
"description": "A unique integer value identifying this power outlet.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
]
},
"/dcim/power-panels/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_power-panels_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "rack_group_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "rack_group_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/PowerPanel"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "dcim_power-panels_create",
"requestBody": {
"$ref": "#/components/requestBodies/WritablePowerPanel"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerPanel"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/power-panels/{id}/": {
"delete": {
"description": "",
"operationId": "dcim_power-panels_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"dcim"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_power-panels_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerPanel"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [
{
"description": "A unique integer value identifying this power panel.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "dcim_power-panels_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritablePowerPanel"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerPanel"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"put": {
"description": "",
"operationId": "dcim_power-panels_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritablePowerPanel"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerPanel"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/power-port-templates/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_power-port-templates_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "type",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "maximum_draw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "allocated_draw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "devicetype_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "type__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "maximum_draw__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "maximum_draw__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "maximum_draw__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "maximum_draw__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "maximum_draw__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "allocated_draw__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "allocated_draw__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "allocated_draw__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "allocated_draw__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "allocated_draw__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "devicetype_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/PowerPortTemplate"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "dcim_power-port-templates_create",
"requestBody": {
"$ref": "#/components/requestBodies/WritablePowerPortTemplate"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerPortTemplate"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/power-port-templates/{id}/": {
"delete": {
"description": "",
"operationId": "dcim_power-port-templates_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"dcim"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_power-port-templates_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerPortTemplate"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [
{
"description": "A unique integer value identifying this power port template.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "dcim_power-port-templates_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritablePowerPortTemplate"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerPortTemplate"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"put": {
"description": "",
"operationId": "dcim_power-port-templates_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritablePowerPortTemplate"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerPortTemplate"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/power-ports/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_power-ports_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "maximum_draw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "allocated_draw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "connection_status",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "type",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "cabled",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "maximum_draw__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "maximum_draw__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "maximum_draw__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "maximum_draw__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "maximum_draw__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "allocated_draw__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "allocated_draw__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "allocated_draw__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "allocated_draw__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "allocated_draw__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "connection_status__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "type__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/PowerPort"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "dcim_power-ports_create",
"requestBody": {
"$ref": "#/components/requestBodies/WritablePowerPort"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerPort"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/power-ports/{id}/": {
"delete": {
"description": "",
"operationId": "dcim_power-ports_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"dcim"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_power-ports_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerPort"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [
{
"description": "A unique integer value identifying this power port.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "dcim_power-ports_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritablePowerPort"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerPort"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"put": {
"description": "",
"operationId": "dcim_power-ports_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritablePowerPort"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerPort"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/power-ports/{id}/trace/": {
"get": {
"description": "Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).",
"operationId": "dcim_power-ports_trace",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerPort"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [
{
"description": "A unique integer value identifying this power port.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
]
},
"/dcim/rack-groups/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_rack-groups_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "parent_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "parent",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "parent_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "parent__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/RackGroup"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "dcim_rack-groups_create",
"requestBody": {
"$ref": "#/components/requestBodies/WritableRackGroup"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RackGroup"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/rack-groups/{id}/": {
"delete": {
"description": "",
"operationId": "dcim_rack-groups_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"dcim"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_rack-groups_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RackGroup"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [
{
"description": "A unique integer value identifying this rack group.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "dcim_rack-groups_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableRackGroup"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RackGroup"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"put": {
"description": "",
"operationId": "dcim_rack-groups_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableRackGroup"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RackGroup"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/rack-reservations/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_rack-reservations_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_group_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_group",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "rack_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "group_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "group",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "user_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "user",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_group_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_group__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "rack_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "group_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "group__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "user_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "user__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/RackReservation"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "dcim_rack-reservations_create",
"requestBody": {
"$ref": "#/components/requestBodies/WritableRackReservation"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RackReservation"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/rack-reservations/{id}/": {
"delete": {
"description": "",
"operationId": "dcim_rack-reservations_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"dcim"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_rack-reservations_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RackReservation"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [
{
"description": "A unique integer value identifying this rack reservation.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "dcim_rack-reservations_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableRackReservation"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RackReservation"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"put": {
"description": "",
"operationId": "dcim_rack-reservations_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableRackReservation"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RackReservation"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/rack-roles/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_rack-roles_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "color",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "color__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "color__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "color__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "color__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "color__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "color__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "color__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "color__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "color__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/RackRole"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "dcim_rack-roles_create",
"requestBody": {
"$ref": "#/components/requestBodies/RackRole"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RackRole"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/rack-roles/{id}/": {
"delete": {
"description": "",
"operationId": "dcim_rack-roles_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"dcim"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_rack-roles_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RackRole"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [
{
"description": "A unique integer value identifying this rack role.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "dcim_rack-roles_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/RackRole"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RackRole"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"put": {
"description": "",
"operationId": "dcim_rack-roles_update",
"requestBody": {
"$ref": "#/components/requestBodies/RackRole"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RackRole"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/racks/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_racks_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "facility_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "asset_tag",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "type",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "width",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "u_height",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "desc_units",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "outer_width",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "outer_depth",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "outer_unit",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_group_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_group",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "group_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "group",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "status",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "role_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "role",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "serial",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "facility_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "facility_id__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "facility_id__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "facility_id__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "facility_id__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "facility_id__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "facility_id__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "facility_id__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "facility_id__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "asset_tag__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "asset_tag__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "asset_tag__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "asset_tag__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "asset_tag__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "asset_tag__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "asset_tag__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "asset_tag__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "asset_tag__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "type__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "width__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "u_height__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "u_height__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "u_height__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "u_height__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "u_height__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "outer_width__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "outer_width__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "outer_width__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "outer_width__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "outer_width__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "outer_depth__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "outer_depth__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "outer_depth__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "outer_depth__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "outer_depth__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "outer_unit__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_group_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_group__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "group_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "group__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "status__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "role_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "role__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/Rack"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "dcim_racks_create",
"requestBody": {
"$ref": "#/components/requestBodies/WritableRack"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Rack"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/racks/{id}/": {
"delete": {
"description": "",
"operationId": "dcim_racks_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"dcim"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_racks_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Rack"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [
{
"description": "A unique integer value identifying this rack.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "dcim_racks_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableRack"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Rack"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"put": {
"description": "",
"operationId": "dcim_racks_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableRack"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Rack"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/racks/{id}/elevation/": {
"get": {
"description": "Rack elevation representing the list of rack units. Also supports rendering the elevation as an SVG.",
"operationId": "dcim_racks_elevation",
"parameters": [
{
"in": "query",
"name": "q",
"required": false,
"schema": {
"minLength": 1,
"type": "string"
}
},
{
"in": "query",
"name": "face",
"required": false,
"schema": {
"default": "front",
"enum": [
"front",
"rear"
],
"type": "string"
}
},
{
"in": "query",
"name": "render",
"required": false,
"schema": {
"default": "json",
"enum": [
"json",
"svg"
],
"type": "string"
}
},
{
"in": "query",
"name": "unit_width",
"required": false,
"schema": {
"default": 220,
"type": "integer"
}
},
{
"in": "query",
"name": "unit_height",
"required": false,
"schema": {
"default": 22,
"type": "integer"
}
},
{
"in": "query",
"name": "legend_width",
"required": false,
"schema": {
"default": 30,
"type": "integer"
}
},
{
"in": "query",
"name": "exclude",
"required": false,
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "expand_devices",
"required": false,
"schema": {
"default": true,
"type": "boolean"
}
},
{
"in": "query",
"name": "include_images",
"required": false,
"schema": {
"default": true,
"type": "boolean"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/RackUnit"
},
"type": "array"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [
{
"description": "A unique integer value identifying this rack.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
]
},
"/dcim/rear-port-templates/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_rear-port-templates_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "type",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "positions",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "devicetype_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "type__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "positions__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "positions__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "positions__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "positions__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "positions__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "devicetype_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/RearPortTemplate"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "dcim_rear-port-templates_create",
"requestBody": {
"$ref": "#/components/requestBodies/WritableRearPortTemplate"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RearPortTemplate"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/rear-port-templates/{id}/": {
"delete": {
"description": "",
"operationId": "dcim_rear-port-templates_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"dcim"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_rear-port-templates_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RearPortTemplate"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [
{
"description": "A unique integer value identifying this rear port template.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "dcim_rear-port-templates_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableRearPortTemplate"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RearPortTemplate"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"put": {
"description": "",
"operationId": "dcim_rear-port-templates_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableRearPortTemplate"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RearPortTemplate"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/rear-ports/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_rear-ports_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "type",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "positions",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "cabled",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "type__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "positions__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "positions__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "positions__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "positions__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "positions__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/RearPort"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "dcim_rear-ports_create",
"requestBody": {
"$ref": "#/components/requestBodies/WritableRearPort"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RearPort"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/rear-ports/{id}/": {
"delete": {
"description": "",
"operationId": "dcim_rear-ports_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"dcim"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_rear-ports_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RearPort"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [
{
"description": "A unique integer value identifying this rear port.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "dcim_rear-ports_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableRearPort"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RearPort"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"put": {
"description": "",
"operationId": "dcim_rear-ports_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableRearPort"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RearPort"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/rear-ports/{id}/trace/": {
"get": {
"description": "Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).",
"operationId": "dcim_rear-ports_trace",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RearPort"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [
{
"description": "A unique integer value identifying this rear port.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
]
},
"/dcim/regions/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_regions_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "parent_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "parent",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "parent_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "parent__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/Region"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "dcim_regions_create",
"requestBody": {
"$ref": "#/components/requestBodies/WritableRegion"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Region"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/regions/{id}/": {
"delete": {
"description": "",
"operationId": "dcim_regions_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"dcim"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_regions_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Region"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [
{
"description": "A unique integer value identifying this region.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "dcim_regions_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableRegion"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Region"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"put": {
"description": "",
"operationId": "dcim_regions_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableRegion"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Region"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/sites/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_sites_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "facility",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "asn",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "latitude",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "longitude",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "contact_name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "contact_phone",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "contact_email",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_group_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_group",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "status",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "facility__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "facility__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "facility__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "facility__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "facility__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "facility__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "facility__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "facility__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "facility__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "asn__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "asn__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "asn__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "asn__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "asn__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "latitude__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "latitude__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "latitude__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "latitude__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "latitude__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "longitude__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "longitude__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "longitude__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "longitude__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "longitude__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "contact_name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "contact_name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "contact_name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "contact_name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "contact_name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "contact_name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "contact_name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "contact_name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "contact_name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "contact_phone__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "contact_phone__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "contact_phone__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "contact_phone__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "contact_phone__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "contact_phone__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "contact_phone__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "contact_phone__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "contact_phone__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "contact_email__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "contact_email__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "contact_email__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "contact_email__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "contact_email__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "contact_email__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "contact_email__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "contact_email__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "contact_email__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_group_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_group__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "status__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/Site"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "dcim_sites_create",
"requestBody": {
"$ref": "#/components/requestBodies/WritableSite"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Site"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/sites/{id}/": {
"delete": {
"description": "",
"operationId": "dcim_sites_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"dcim"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_sites_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Site"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [
{
"description": "A unique integer value identifying this site.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "dcim_sites_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableSite"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Site"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"put": {
"description": "",
"operationId": "dcim_sites_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableSite"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Site"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/sites/{id}/graphs/": {
"get": {
"description": "A convenience method for rendering graphs for a particular site.",
"operationId": "dcim_sites_graphs",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Site"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [
{
"description": "A unique integer value identifying this site.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
]
},
"/dcim/virtual-chassis/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_virtual-chassis_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "domain",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "domain__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "domain__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "domain__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "domain__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "domain__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "domain__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "domain__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "domain__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "domain__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/VirtualChassis"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "dcim_virtual-chassis_create",
"requestBody": {
"$ref": "#/components/requestBodies/WritableVirtualChassis"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualChassis"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/dcim/virtual-chassis/{id}/": {
"delete": {
"description": "",
"operationId": "dcim_virtual-chassis_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"dcim"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "dcim_virtual-chassis_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualChassis"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"parameters": [
{
"description": "A unique integer value identifying this virtual chassis.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "dcim_virtual-chassis_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableVirtualChassis"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualChassis"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
},
"put": {
"description": "",
"operationId": "dcim_virtual-chassis_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableVirtualChassis"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualChassis"
}
}
},
"description": ""
}
},
"tags": [
"dcim"
]
}
},
"/extras/_custom_field_choices/": {
"get": {
"description": "",
"operationId": "extras__custom_field_choices_list",
"responses": {
"200": {
"description": ""
}
},
"tags": [
"extras"
]
},
"parameters": []
},
"/extras/_custom_field_choices/{id}/": {
"get": {
"description": "",
"operationId": "extras__custom_field_choices_read",
"responses": {
"200": {
"description": ""
}
},
"tags": [
"extras"
]
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
]
},
"/extras/config-contexts/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "extras_config-contexts_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "is_active",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "role_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "role",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "platform_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "platform",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "cluster_group_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "cluster_group",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "cluster_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_group_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_group",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "role_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "role__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "platform_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "platform__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "cluster_group_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "cluster_group__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "cluster_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_group_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_group__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/ConfigContext"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"extras"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "extras_config-contexts_create",
"requestBody": {
"$ref": "#/components/requestBodies/WritableConfigContext"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigContext"
}
}
},
"description": ""
}
},
"tags": [
"extras"
]
}
},
"/extras/config-contexts/{id}/": {
"delete": {
"description": "",
"operationId": "extras_config-contexts_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"extras"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "extras_config-contexts_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigContext"
}
}
},
"description": ""
}
},
"tags": [
"extras"
]
},
"parameters": [
{
"description": "A unique integer value identifying this config context.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "extras_config-contexts_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableConfigContext"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigContext"
}
}
},
"description": ""
}
},
"tags": [
"extras"
]
},
"put": {
"description": "",
"operationId": "extras_config-contexts_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableConfigContext"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigContext"
}
}
},
"description": ""
}
},
"tags": [
"extras"
]
}
},
"/extras/export-templates/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "extras_export-templates_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "content_type",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "template_language",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "content_type__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "template_language__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/ExportTemplate"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"extras"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "extras_export-templates_create",
"requestBody": {
"$ref": "#/components/requestBodies/WritableExportTemplate"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportTemplate"
}
}
},
"description": ""
}
},
"tags": [
"extras"
]
}
},
"/extras/export-templates/{id}/": {
"delete": {
"description": "",
"operationId": "extras_export-templates_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"extras"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "extras_export-templates_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportTemplate"
}
}
},
"description": ""
}
},
"tags": [
"extras"
]
},
"parameters": [
{
"description": "A unique integer value identifying this export template.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "extras_export-templates_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableExportTemplate"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportTemplate"
}
}
},
"description": ""
}
},
"tags": [
"extras"
]
},
"put": {
"description": "",
"operationId": "extras_export-templates_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableExportTemplate"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportTemplate"
}
}
},
"description": ""
}
},
"tags": [
"extras"
]
}
},
"/extras/graphs/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "extras_graphs_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "type",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "template_language",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "type__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "template_language__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/Graph"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"extras"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "extras_graphs_create",
"requestBody": {
"$ref": "#/components/requestBodies/Graph"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Graph"
}
}
},
"description": ""
}
},
"tags": [
"extras"
]
}
},
"/extras/graphs/{id}/": {
"delete": {
"description": "",
"operationId": "extras_graphs_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"extras"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "extras_graphs_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Graph"
}
}
},
"description": ""
}
},
"tags": [
"extras"
]
},
"parameters": [
{
"description": "A unique integer value identifying this graph.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "extras_graphs_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/Graph"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Graph"
}
}
},
"description": ""
}
},
"tags": [
"extras"
]
},
"put": {
"description": "",
"operationId": "extras_graphs_update",
"requestBody": {
"$ref": "#/components/requestBodies/Graph"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Graph"
}
}
},
"description": ""
}
},
"tags": [
"extras"
]
}
},
"/extras/image-attachments/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "extras_image-attachments_list",
"parameters": [
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/ImageAttachment"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"extras"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "extras_image-attachments_create",
"requestBody": {
"$ref": "#/components/requestBodies/ImageAttachment"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImageAttachment"
}
}
},
"description": ""
}
},
"tags": [
"extras"
]
}
},
"/extras/image-attachments/{id}/": {
"delete": {
"description": "",
"operationId": "extras_image-attachments_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"extras"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "extras_image-attachments_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImageAttachment"
}
}
},
"description": ""
}
},
"tags": [
"extras"
]
},
"parameters": [
{
"description": "A unique integer value identifying this image attachment.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "extras_image-attachments_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/ImageAttachment"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImageAttachment"
}
}
},
"description": ""
}
},
"tags": [
"extras"
]
},
"put": {
"description": "",
"operationId": "extras_image-attachments_update",
"requestBody": {
"$ref": "#/components/requestBodies/ImageAttachment"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImageAttachment"
}
}
},
"description": ""
}
},
"tags": [
"extras"
]
}
},
"/extras/object-changes/": {
"get": {
"description": "Retrieve a list of recent changes.",
"operationId": "extras_object-changes_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "user",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "user_name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "request_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "action",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "changed_object_type",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "changed_object_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "object_repr",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "time",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "user__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "user_name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "user_name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "user_name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "user_name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "user_name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "user_name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "user_name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "user_name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "user_name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "action__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "changed_object_type__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "changed_object_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "changed_object_id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "changed_object_id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "changed_object_id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "changed_object_id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "object_repr__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "object_repr__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "object_repr__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "object_repr__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "object_repr__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "object_repr__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "object_repr__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "object_repr__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "object_repr__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/ObjectChange"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"extras"
]
},
"parameters": []
},
"/extras/object-changes/{id}/": {
"get": {
"description": "Retrieve a list of recent changes.",
"operationId": "extras_object-changes_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectChange"
}
}
},
"description": ""
}
},
"tags": [
"extras"
]
},
"parameters": [
{
"description": "A unique integer value identifying this object change.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
]
},
"/extras/reports/": {
"get": {
"description": "Compile all reports and their related results (if any). Result data is deferred in the list view.",
"operationId": "extras_reports_list",
"responses": {
"200": {
"description": ""
}
},
"tags": [
"extras"
]
},
"parameters": []
},
"/extras/reports/{id}/": {
"get": {
"description": "Retrieve a single Report identified as \"<module>.<report>\".",
"operationId": "extras_reports_read",
"responses": {
"200": {
"description": ""
}
},
"tags": [
"extras"
]
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
]
},
"/extras/reports/{id}/run/": {
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"description": "Run a Report and create a new ReportResult, overwriting any previous result for the Report.",
"operationId": "extras_reports_run",
"responses": {
"201": {
"description": ""
}
},
"tags": [
"extras"
]
}
},
"/extras/scripts/": {
"get": {
"description": "",
"operationId": "extras_scripts_list",
"responses": {
"200": {
"description": ""
}
},
"tags": [
"extras"
]
},
"parameters": []
},
"/extras/scripts/{id}/": {
"get": {
"description": "",
"operationId": "extras_scripts_read",
"responses": {
"200": {
"description": ""
}
},
"tags": [
"extras"
]
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
]
},
"/extras/tags/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "extras_tags_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "color",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "color__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "color__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "color__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "color__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "color__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "color__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "color__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "color__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "color__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/Tag"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"extras"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "extras_tags_create",
"requestBody": {
"$ref": "#/components/requestBodies/Tag"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tag"
}
}
},
"description": ""
}
},
"tags": [
"extras"
]
}
},
"/extras/tags/{id}/": {
"delete": {
"description": "",
"operationId": "extras_tags_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"extras"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "extras_tags_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tag"
}
}
},
"description": ""
}
},
"tags": [
"extras"
]
},
"parameters": [
{
"description": "A unique integer value identifying this tag.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "extras_tags_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/Tag"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tag"
}
}
},
"description": ""
}
},
"tags": [
"extras"
]
},
"put": {
"description": "",
"operationId": "extras_tags_update",
"requestBody": {
"$ref": "#/components/requestBodies/Tag"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tag"
}
}
},
"description": ""
}
},
"tags": [
"extras"
]
}
},
"/ipam/aggregates/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "ipam_aggregates_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "date_added",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "family",
"required": false,
"schema": {
"type": "number"
}
},
{
"description": "",
"in": "query",
"name": "prefix",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "rir_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "rir",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "date_added__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "date_added__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "date_added__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "date_added__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "date_added__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "rir_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "rir__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/Aggregate"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"ipam"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "ipam_aggregates_create",
"requestBody": {
"$ref": "#/components/requestBodies/WritableAggregate"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Aggregate"
}
}
},
"description": ""
}
},
"tags": [
"ipam"
]
}
},
"/ipam/aggregates/{id}/": {
"delete": {
"description": "",
"operationId": "ipam_aggregates_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"ipam"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "ipam_aggregates_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Aggregate"
}
}
},
"description": ""
}
},
"tags": [
"ipam"
]
},
"parameters": [
{
"description": "A unique integer value identifying this aggregate.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "ipam_aggregates_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableAggregate"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Aggregate"
}
}
},
"description": ""
}
},
"tags": [
"ipam"
]
},
"put": {
"description": "",
"operationId": "ipam_aggregates_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableAggregate"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Aggregate"
}
}
},
"description": ""
}
},
"tags": [
"ipam"
]
}
},
"/ipam/ip-addresses/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "ipam_ip-addresses_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "dns_name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_group_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_group",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "family",
"required": false,
"schema": {
"type": "number"
}
},
{
"description": "",
"in": "query",
"name": "parent",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "address",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mask_length",
"required": false,
"schema": {
"type": "number"
}
},
{
"description": "",
"in": "query",
"name": "vrf_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "vrf",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "virtual_machine_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "virtual_machine",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "interface",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "interface_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "assigned_to_interface",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "status",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "role",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "dns_name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "dns_name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "dns_name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "dns_name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "dns_name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "dns_name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "dns_name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "dns_name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "dns_name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_group_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_group__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "vrf_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "vrf__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "virtual_machine_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "virtual_machine__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "interface__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "interface_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "status__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "role__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/IPAddress"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"ipam"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "ipam_ip-addresses_create",
"requestBody": {
"$ref": "#/components/requestBodies/WritableIPAddress"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPAddress"
}
}
},
"description": ""
}
},
"tags": [
"ipam"
]
}
},
"/ipam/ip-addresses/{id}/": {
"delete": {
"description": "",
"operationId": "ipam_ip-addresses_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"ipam"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "ipam_ip-addresses_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPAddress"
}
}
},
"description": ""
}
},
"tags": [
"ipam"
]
},
"parameters": [
{
"description": "A unique integer value identifying this IP address.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "ipam_ip-addresses_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableIPAddress"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPAddress"
}
}
},
"description": ""
}
},
"tags": [
"ipam"
]
},
"put": {
"description": "",
"operationId": "ipam_ip-addresses_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableIPAddress"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPAddress"
}
}
},
"description": ""
}
},
"tags": [
"ipam"
]
}
},
"/ipam/prefixes/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "ipam_prefixes_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "is_pool",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_group_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_group",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "family",
"required": false,
"schema": {
"type": "number"
}
},
{
"description": "",
"in": "query",
"name": "prefix",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "within",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "within_include",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "contains",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mask_length",
"required": false,
"schema": {
"type": "number"
}
},
{
"description": "",
"in": "query",
"name": "vrf_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "vrf",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "vlan_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "vlan_vid",
"required": false,
"schema": {
"type": "number"
}
},
{
"description": "",
"in": "query",
"name": "role_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "role",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "status",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_group_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_group__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "vrf_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "vrf__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "vlan_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "role_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "role__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "status__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/Prefix"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"ipam"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "ipam_prefixes_create",
"requestBody": {
"$ref": "#/components/requestBodies/WritablePrefix"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Prefix"
}
}
},
"description": ""
}
},
"tags": [
"ipam"
]
}
},
"/ipam/prefixes/{id}/": {
"delete": {
"description": "",
"operationId": "ipam_prefixes_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"ipam"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "ipam_prefixes_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Prefix"
}
}
},
"description": ""
}
},
"tags": [
"ipam"
]
},
"parameters": [
{
"description": "A unique integer value identifying this prefix.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "ipam_prefixes_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritablePrefix"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Prefix"
}
}
},
"description": ""
}
},
"tags": [
"ipam"
]
},
"put": {
"description": "",
"operationId": "ipam_prefixes_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritablePrefix"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Prefix"
}
}
},
"description": ""
}
},
"tags": [
"ipam"
]
}
},
"/ipam/prefixes/{id}/available-ips/": {
"get": {
"description": "A convenience method for returning available IP addresses within a prefix. By default, the number of IPs\nreturned will be equivalent to PAGINATE_COUNT. An arbitrary limit (up to MAX_PAGE_SIZE, if set) may be passed,\nhowever results will not be paginated.\n\nThe advisory lock decorator uses a PostgreSQL advisory lock to prevent this API from being\ninvoked in parallel, which results in a race condition where multiple insertions can occur.",
"operationId": "ipam_prefixes_available-ips_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/AvailableIP"
},
"type": "array"
}
}
},
"description": ""
}
},
"tags": [
"ipam"
]
},
"parameters": [
{
"description": "A unique integer value identifying this prefix.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"post": {
"description": "A convenience method for returning available IP addresses within a prefix. By default, the number of IPs\nreturned will be equivalent to PAGINATE_COUNT. An arbitrary limit (up to MAX_PAGE_SIZE, if set) may be passed,\nhowever results will not be paginated.\n\nThe advisory lock decorator uses a PostgreSQL advisory lock to prevent this API from being\ninvoked in parallel, which results in a race condition where multiple insertions can occur.",
"operationId": "ipam_prefixes_available-ips_create",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableAvailableIP"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/AvailableIP"
},
"type": "array"
}
}
},
"description": ""
}
},
"tags": [
"ipam"
]
}
},
"/ipam/prefixes/{id}/available-prefixes/": {
"get": {
"description": "The advisory lock decorator uses a PostgreSQL advisory lock to prevent this API from being\ninvoked in parallel, which results in a race condition where multiple insertions can occur.",
"operationId": "ipam_prefixes_available-prefixes_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/AvailablePrefix"
},
"type": "array"
}
}
},
"description": ""
}
},
"summary": "A convenience method for returning available child prefixes within a parent.",
"tags": [
"ipam"
]
},
"parameters": [
{
"description": "A unique integer value identifying this prefix.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"post": {
"description": "The advisory lock decorator uses a PostgreSQL advisory lock to prevent this API from being\ninvoked in parallel, which results in a race condition where multiple insertions can occur.",
"operationId": "ipam_prefixes_available-prefixes_create",
"requestBody": {
"$ref": "#/components/requestBodies/WritablePrefix"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/AvailablePrefix"
},
"type": "array"
}
}
},
"description": ""
}
},
"summary": "A convenience method for returning available child prefixes within a parent.",
"tags": [
"ipam"
]
}
},
"/ipam/rirs/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "ipam_rirs_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "is_private",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/RIR"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"ipam"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "ipam_rirs_create",
"requestBody": {
"$ref": "#/components/requestBodies/RIR"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RIR"
}
}
},
"description": ""
}
},
"tags": [
"ipam"
]
}
},
"/ipam/rirs/{id}/": {
"delete": {
"description": "",
"operationId": "ipam_rirs_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"ipam"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "ipam_rirs_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RIR"
}
}
},
"description": ""
}
},
"tags": [
"ipam"
]
},
"parameters": [
{
"description": "A unique integer value identifying this RIR.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "ipam_rirs_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/RIR"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RIR"
}
}
},
"description": ""
}
},
"tags": [
"ipam"
]
},
"put": {
"description": "",
"operationId": "ipam_rirs_update",
"requestBody": {
"$ref": "#/components/requestBodies/RIR"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RIR"
}
}
},
"description": ""
}
},
"tags": [
"ipam"
]
}
},
"/ipam/roles/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "ipam_roles_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/Role"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"ipam"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "ipam_roles_create",
"requestBody": {
"$ref": "#/components/requestBodies/Role"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Role"
}
}
},
"description": ""
}
},
"tags": [
"ipam"
]
}
},
"/ipam/roles/{id}/": {
"delete": {
"description": "",
"operationId": "ipam_roles_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"ipam"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "ipam_roles_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Role"
}
}
},
"description": ""
}
},
"tags": [
"ipam"
]
},
"parameters": [
{
"description": "A unique integer value identifying this role.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "ipam_roles_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/Role"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Role"
}
}
},
"description": ""
}
},
"tags": [
"ipam"
]
},
"put": {
"description": "",
"operationId": "ipam_roles_update",
"requestBody": {
"$ref": "#/components/requestBodies/Role"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Role"
}
}
},
"description": ""
}
},
"tags": [
"ipam"
]
}
},
"/ipam/services/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "ipam_services_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "protocol",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "port",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "virtual_machine_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "virtual_machine",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "protocol__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "port__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "port__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "port__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "port__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "port__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "virtual_machine_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "virtual_machine__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/Service"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"ipam"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "ipam_services_create",
"requestBody": {
"$ref": "#/components/requestBodies/WritableService"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Service"
}
}
},
"description": ""
}
},
"tags": [
"ipam"
]
}
},
"/ipam/services/{id}/": {
"delete": {
"description": "",
"operationId": "ipam_services_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"ipam"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "ipam_services_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Service"
}
}
},
"description": ""
}
},
"tags": [
"ipam"
]
},
"parameters": [
{
"description": "A unique integer value identifying this service.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "ipam_services_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableService"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Service"
}
}
},
"description": ""
}
},
"tags": [
"ipam"
]
},
"put": {
"description": "",
"operationId": "ipam_services_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableService"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Service"
}
}
},
"description": ""
}
},
"tags": [
"ipam"
]
}
},
"/ipam/vlan-groups/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "ipam_vlan-groups_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/VLANGroup"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"ipam"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "ipam_vlan-groups_create",
"requestBody": {
"$ref": "#/components/requestBodies/WritableVLANGroup"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VLANGroup"
}
}
},
"description": ""
}
},
"tags": [
"ipam"
]
}
},
"/ipam/vlan-groups/{id}/": {
"delete": {
"description": "",
"operationId": "ipam_vlan-groups_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"ipam"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "ipam_vlan-groups_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VLANGroup"
}
}
},
"description": ""
}
},
"tags": [
"ipam"
]
},
"parameters": [
{
"description": "A unique integer value identifying this VLAN group.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "ipam_vlan-groups_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableVLANGroup"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VLANGroup"
}
}
},
"description": ""
}
},
"tags": [
"ipam"
]
},
"put": {
"description": "",
"operationId": "ipam_vlan-groups_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableVLANGroup"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VLANGroup"
}
}
},
"description": ""
}
},
"tags": [
"ipam"
]
}
},
"/ipam/vlans/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "ipam_vlans_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "vid",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_group_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_group",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "group_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "group",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "role_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "role",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "status",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "vid__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "vid__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "vid__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "vid__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "vid__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_group_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_group__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "group_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "group__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "role_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "role__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "status__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/VLAN"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"ipam"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "ipam_vlans_create",
"requestBody": {
"$ref": "#/components/requestBodies/WritableVLAN"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VLAN"
}
}
},
"description": ""
}
},
"tags": [
"ipam"
]
}
},
"/ipam/vlans/{id}/": {
"delete": {
"description": "",
"operationId": "ipam_vlans_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"ipam"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "ipam_vlans_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VLAN"
}
}
},
"description": ""
}
},
"tags": [
"ipam"
]
},
"parameters": [
{
"description": "A unique integer value identifying this VLAN.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "ipam_vlans_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableVLAN"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VLAN"
}
}
},
"description": ""
}
},
"tags": [
"ipam"
]
},
"put": {
"description": "",
"operationId": "ipam_vlans_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableVLAN"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VLAN"
}
}
},
"description": ""
}
},
"tags": [
"ipam"
]
}
},
"/ipam/vrfs/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "ipam_vrfs_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "rd",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "enforce_unique",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_group_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_group",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "rd__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "rd__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "rd__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "rd__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "rd__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "rd__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "rd__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "rd__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "rd__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_group_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_group__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/VRF"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"ipam"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "ipam_vrfs_create",
"requestBody": {
"$ref": "#/components/requestBodies/WritableVRF"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VRF"
}
}
},
"description": ""
}
},
"tags": [
"ipam"
]
}
},
"/ipam/vrfs/{id}/": {
"delete": {
"description": "",
"operationId": "ipam_vrfs_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"ipam"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "ipam_vrfs_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VRF"
}
}
},
"description": ""
}
},
"tags": [
"ipam"
]
},
"parameters": [
{
"description": "A unique integer value identifying this VRF.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "ipam_vrfs_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableVRF"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VRF"
}
}
},
"description": ""
}
},
"tags": [
"ipam"
]
},
"put": {
"description": "",
"operationId": "ipam_vrfs_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableVRF"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VRF"
}
}
},
"description": ""
}
},
"tags": [
"ipam"
]
}
},
"/secrets/generate-rsa-key-pair/": {
"get": {
"description": "{\n \"public_key\": \"<public key>\",\n \"private_key\": \"<private key>\"\n }",
"operationId": "secrets_generate-rsa-key-pair_list",
"responses": {
"200": {
"description": ""
}
},
"summary": "This endpoint can be used to generate a new RSA key pair. The keys are returned in PEM format.",
"tags": [
"secrets"
]
},
"parameters": []
},
"/secrets/get-session-key/": {
"parameters": [],
"post": {
"description": "Retrieve a temporary session key to use for encrypting and decrypting secrets via the API. The user's private RSA\nkey is POSTed with the name `private_key`. An example:\n\n curl -v -X POST -H \"Authorization: Token <token>\" -H \"Accept: application/json; indent=4\" \\\n --data-urlencode \"private_key@<filename>\" https://netbox/api/secrets/get-session-key/\n\nThis request will yield a base64-encoded session key to be included in an `X-Session-Key` header in future requests:\n\n {\n \"session_key\": \"+8t4SI6XikgVmB5+/urhozx9O5qCQANyOk1MNe6taRf=\"\n }\n\nThis endpoint accepts one optional parameter: `preserve_key`. If True and a session key exists, the existing session\nkey will be returned instead of a new one.",
"operationId": "secrets_get-session-key_create",
"responses": {
"201": {
"description": ""
}
},
"tags": [
"secrets"
]
}
},
"/secrets/secret-roles/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "secrets_secret-roles_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/SecretRole"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"secrets"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "secrets_secret-roles_create",
"requestBody": {
"$ref": "#/components/requestBodies/SecretRole"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SecretRole"
}
}
},
"description": ""
}
},
"tags": [
"secrets"
]
}
},
"/secrets/secret-roles/{id}/": {
"delete": {
"description": "",
"operationId": "secrets_secret-roles_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"secrets"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "secrets_secret-roles_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SecretRole"
}
}
},
"description": ""
}
},
"tags": [
"secrets"
]
},
"parameters": [
{
"description": "A unique integer value identifying this secret role.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "secrets_secret-roles_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/SecretRole"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SecretRole"
}
}
},
"description": ""
}
},
"tags": [
"secrets"
]
},
"put": {
"description": "",
"operationId": "secrets_secret-roles_update",
"requestBody": {
"$ref": "#/components/requestBodies/SecretRole"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SecretRole"
}
}
},
"description": ""
}
},
"tags": [
"secrets"
]
}
},
"/secrets/secrets/": {
"get": {
"description": "",
"operationId": "secrets_secrets_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "role_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "role",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "role_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "role__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "device__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/Secret"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"secrets"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "secrets_secrets_create",
"requestBody": {
"$ref": "#/components/requestBodies/WritableSecret"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Secret"
}
}
},
"description": ""
}
},
"tags": [
"secrets"
]
}
},
"/secrets/secrets/{id}/": {
"delete": {
"description": "",
"operationId": "secrets_secrets_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"secrets"
]
},
"get": {
"description": "",
"operationId": "secrets_secrets_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Secret"
}
}
},
"description": ""
}
},
"tags": [
"secrets"
]
},
"parameters": [
{
"description": "A unique integer value identifying this secret.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "secrets_secrets_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableSecret"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Secret"
}
}
},
"description": ""
}
},
"tags": [
"secrets"
]
},
"put": {
"description": "",
"operationId": "secrets_secrets_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableSecret"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Secret"
}
}
},
"description": ""
}
},
"tags": [
"secrets"
]
}
},
"/tenancy/tenant-groups/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "tenancy_tenant-groups_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "parent_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "parent",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "parent_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "parent__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/TenantGroup"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"tenancy"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "tenancy_tenant-groups_create",
"requestBody": {
"$ref": "#/components/requestBodies/WritableTenantGroup"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TenantGroup"
}
}
},
"description": ""
}
},
"tags": [
"tenancy"
]
}
},
"/tenancy/tenant-groups/{id}/": {
"delete": {
"description": "",
"operationId": "tenancy_tenant-groups_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"tenancy"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "tenancy_tenant-groups_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TenantGroup"
}
}
},
"description": ""
}
},
"tags": [
"tenancy"
]
},
"parameters": [
{
"description": "A unique integer value identifying this tenant group.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "tenancy_tenant-groups_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableTenantGroup"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TenantGroup"
}
}
},
"description": ""
}
},
"tags": [
"tenancy"
]
},
"put": {
"description": "",
"operationId": "tenancy_tenant-groups_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableTenantGroup"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TenantGroup"
}
}
},
"description": ""
}
},
"tags": [
"tenancy"
]
}
},
"/tenancy/tenants/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "tenancy_tenants_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "group_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "group",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "group_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "group__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/Tenant"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"tenancy"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "tenancy_tenants_create",
"requestBody": {
"$ref": "#/components/requestBodies/WritableTenant"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tenant"
}
}
},
"description": ""
}
},
"tags": [
"tenancy"
]
}
},
"/tenancy/tenants/{id}/": {
"delete": {
"description": "",
"operationId": "tenancy_tenants_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"tenancy"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "tenancy_tenants_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tenant"
}
}
},
"description": ""
}
},
"tags": [
"tenancy"
]
},
"parameters": [
{
"description": "A unique integer value identifying this tenant.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "tenancy_tenants_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableTenant"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tenant"
}
}
},
"description": ""
}
},
"tags": [
"tenancy"
]
},
"put": {
"description": "",
"operationId": "tenancy_tenants_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableTenant"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tenant"
}
}
},
"description": ""
}
},
"tags": [
"tenancy"
]
}
},
"/virtualization/cluster-groups/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "virtualization_cluster-groups_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/ClusterGroup"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"virtualization"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "virtualization_cluster-groups_create",
"requestBody": {
"$ref": "#/components/requestBodies/ClusterGroup"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClusterGroup"
}
}
},
"description": ""
}
},
"tags": [
"virtualization"
]
}
},
"/virtualization/cluster-groups/{id}/": {
"delete": {
"description": "",
"operationId": "virtualization_cluster-groups_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"virtualization"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "virtualization_cluster-groups_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClusterGroup"
}
}
},
"description": ""
}
},
"tags": [
"virtualization"
]
},
"parameters": [
{
"description": "A unique integer value identifying this cluster group.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "virtualization_cluster-groups_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/ClusterGroup"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClusterGroup"
}
}
},
"description": ""
}
},
"tags": [
"virtualization"
]
},
"put": {
"description": "",
"operationId": "virtualization_cluster-groups_update",
"requestBody": {
"$ref": "#/components/requestBodies/ClusterGroup"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClusterGroup"
}
}
},
"description": ""
}
},
"tags": [
"virtualization"
]
}
},
"/virtualization/cluster-types/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "virtualization_cluster-types_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "slug__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "description__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/ClusterType"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"virtualization"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "virtualization_cluster-types_create",
"requestBody": {
"$ref": "#/components/requestBodies/ClusterType"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClusterType"
}
}
},
"description": ""
}
},
"tags": [
"virtualization"
]
}
},
"/virtualization/cluster-types/{id}/": {
"delete": {
"description": "",
"operationId": "virtualization_cluster-types_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"virtualization"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "virtualization_cluster-types_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClusterType"
}
}
},
"description": ""
}
},
"tags": [
"virtualization"
]
},
"parameters": [
{
"description": "A unique integer value identifying this cluster type.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "virtualization_cluster-types_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/ClusterType"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClusterType"
}
}
},
"description": ""
}
},
"tags": [
"virtualization"
]
},
"put": {
"description": "",
"operationId": "virtualization_cluster-types_update",
"requestBody": {
"$ref": "#/components/requestBodies/ClusterType"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClusterType"
}
}
},
"description": ""
}
},
"tags": [
"virtualization"
]
}
},
"/virtualization/clusters/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "virtualization_clusters_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_group_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_group",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "group_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "group",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "type_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "type",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_group_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_group__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "group_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "group__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "type_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "type__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/Cluster"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"virtualization"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "virtualization_clusters_create",
"requestBody": {
"$ref": "#/components/requestBodies/WritableCluster"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Cluster"
}
}
},
"description": ""
}
},
"tags": [
"virtualization"
]
}
},
"/virtualization/clusters/{id}/": {
"delete": {
"description": "",
"operationId": "virtualization_clusters_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"virtualization"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "virtualization_clusters_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Cluster"
}
}
},
"description": ""
}
},
"tags": [
"virtualization"
]
},
"parameters": [
{
"description": "A unique integer value identifying this cluster.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "virtualization_clusters_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableCluster"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Cluster"
}
}
},
"description": ""
}
},
"tags": [
"virtualization"
]
},
"put": {
"description": "",
"operationId": "virtualization_clusters_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableCluster"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Cluster"
}
}
},
"description": ""
}
},
"tags": [
"virtualization"
]
}
},
"/virtualization/interfaces/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "virtualization_interfaces_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "enabled",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mtu",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "virtual_machine_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "virtual_machine",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mac_address",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mtu__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mtu__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mtu__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mtu__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mtu__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "virtual_machine_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "virtual_machine__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mac_address__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mac_address__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mac_address__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mac_address__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mac_address__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mac_address__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mac_address__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mac_address__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mac_address__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/VirtualMachineInterface"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"virtualization"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "virtualization_interfaces_create",
"requestBody": {
"$ref": "#/components/requestBodies/WritableVirtualMachineInterface"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualMachineInterface"
}
}
},
"description": ""
}
},
"tags": [
"virtualization"
]
}
},
"/virtualization/interfaces/{id}/": {
"delete": {
"description": "",
"operationId": "virtualization_interfaces_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"virtualization"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "virtualization_interfaces_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualMachineInterface"
}
}
},
"description": ""
}
},
"tags": [
"virtualization"
]
},
"parameters": [
{
"description": "A unique integer value identifying this interface.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "virtualization_interfaces_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableVirtualMachineInterface"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualMachineInterface"
}
}
},
"description": ""
}
},
"tags": [
"virtualization"
]
},
"put": {
"description": "",
"operationId": "virtualization_interfaces_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableVirtualMachineInterface"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualMachineInterface"
}
}
},
"description": ""
}
},
"tags": [
"virtualization"
]
}
},
"/virtualization/virtual-machines/": {
"get": {
"description": "Call to super to allow for caching",
"operationId": "virtualization_virtual-machines_list",
"parameters": [
{
"description": "",
"in": "query",
"name": "id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "cluster",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "vcpus",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "memory",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "disk",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "local_context_data",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_group_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_group",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "created__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "last_updated__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "q",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "status",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "cluster_group_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "cluster_group",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "cluster_type_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "cluster_type",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "cluster_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "role_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "role",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "platform_id",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "platform",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mac_address",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "id__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "name__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "cluster__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "vcpus__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "vcpus__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "vcpus__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "vcpus__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "vcpus__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "memory__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "memory__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "memory__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "memory__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "memory__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "disk__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "disk__lte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "disk__lt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "disk__gte",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "disk__gt",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_group_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_group__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tenant__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "status__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "cluster_group_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "cluster_group__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "cluster_type_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "cluster_type__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "cluster_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "region__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "site__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "role_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "role__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "platform_id__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "platform__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mac_address__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mac_address__ic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mac_address__nic",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mac_address__iew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mac_address__niew",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mac_address__isw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mac_address__nisw",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mac_address__ie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "mac_address__nie",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "tag__n",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of results to return per page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "The initial index from which to return the results.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer"
},
"next": {
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/VirtualMachineWithConfigContext"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
}
},
"description": ""
}
},
"tags": [
"virtualization"
]
},
"parameters": [],
"post": {
"description": "",
"operationId": "virtualization_virtual-machines_create",
"requestBody": {
"$ref": "#/components/requestBodies/WritableVirtualMachineWithConfigContext"
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualMachineWithConfigContext"
}
}
},
"description": ""
}
},
"tags": [
"virtualization"
]
}
},
"/virtualization/virtual-machines/{id}/": {
"delete": {
"description": "",
"operationId": "virtualization_virtual-machines_delete",
"responses": {
"204": {
"description": ""
}
},
"tags": [
"virtualization"
]
},
"get": {
"description": "Call to super to allow for caching",
"operationId": "virtualization_virtual-machines_read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualMachineWithConfigContext"
}
}
},
"description": ""
}
},
"tags": [
"virtualization"
]
},
"parameters": [
{
"description": "A unique integer value identifying this virtual machine.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"patch": {
"description": "",
"operationId": "virtualization_virtual-machines_partial_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableVirtualMachineWithConfigContext"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualMachineWithConfigContext"
}
}
},
"description": ""
}
},
"tags": [
"virtualization"
]
},
"put": {
"description": "",
"operationId": "virtualization_virtual-machines_update",
"requestBody": {
"$ref": "#/components/requestBodies/WritableVirtualMachineWithConfigContext"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualMachineWithConfigContext"
}
}
},
"description": ""
}
},
"tags": [
"virtualization"
]
}
}
},
"components": {
"requestBodies": {
"CircuitType": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CircuitType"
}
}
},
"required": true
},
"ClusterGroup": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClusterGroup"
}
}
},
"required": true
},
"ClusterType": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClusterType"
}
}
},
"required": true
},
"DeviceRole": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceRole"
}
}
},
"required": true
},
"Graph": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Graph"
}
}
},
"required": true
},
"ImageAttachment": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImageAttachment"
}
}
},
"required": true
},
"Manufacturer": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Manufacturer"
}
}
},
"required": true
},
"Provider": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Provider"
}
}
},
"required": true
},
"RIR": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RIR"
}
}
},
"required": true
},
"RackRole": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RackRole"
}
}
},
"required": true
},
"Role": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Role"
}
}
},
"required": true
},
"SecretRole": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SecretRole"
}
}
},
"required": true
},
"Tag": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tag"
}
}
},
"required": true
},
"WritableAggregate": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableAggregate"
}
}
},
"required": true
},
"WritableCable": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableCable"
}
}
},
"required": true
},
"WritableCircuit": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableCircuit"
}
}
},
"required": true
},
"WritableCircuitTermination": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableCircuitTermination"
}
}
},
"required": true
},
"WritableCluster": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableCluster"
}
}
},
"required": true
},
"WritableConfigContext": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableConfigContext"
}
}
},
"required": true
},
"WritableConsolePort": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableConsolePort"
}
}
},
"required": true
},
"WritableConsolePortTemplate": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableConsolePortTemplate"
}
}
},
"required": true
},
"WritableConsoleServerPort": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableConsoleServerPort"
}
}
},
"required": true
},
"WritableConsoleServerPortTemplate": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableConsoleServerPortTemplate"
}
}
},
"required": true
},
"WritableDeviceBay": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableDeviceBay"
}
}
},
"required": true
},
"WritableDeviceBayTemplate": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableDeviceBayTemplate"
}
}
},
"required": true
},
"WritableDeviceInterface": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableDeviceInterface"
}
}
},
"required": true
},
"WritableDeviceType": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableDeviceType"
}
}
},
"required": true
},
"WritableDeviceWithConfigContext": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableDeviceWithConfigContext"
}
}
},
"required": true
},
"WritableExportTemplate": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableExportTemplate"
}
}
},
"required": true
},
"WritableFrontPort": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableFrontPort"
}
}
},
"required": true
},
"WritableFrontPortTemplate": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableFrontPortTemplate"
}
}
},
"required": true
},
"WritableIPAddress": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableIPAddress"
}
}
},
"required": true
},
"WritableInterfaceTemplate": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableInterfaceTemplate"
}
}
},
"required": true
},
"WritableInventoryItem": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableInventoryItem"
}
}
},
"required": true
},
"WritablePlatform": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritablePlatform"
}
}
},
"required": true
},
"WritablePowerFeed": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritablePowerFeed"
}
}
},
"required": true
},
"WritablePowerOutlet": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritablePowerOutlet"
}
}
},
"required": true
},
"WritablePowerOutletTemplate": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritablePowerOutletTemplate"
}
}
},
"required": true
},
"WritablePowerPanel": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritablePowerPanel"
}
}
},
"required": true
},
"WritablePowerPort": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritablePowerPort"
}
}
},
"required": true
},
"WritablePowerPortTemplate": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritablePowerPortTemplate"
}
}
},
"required": true
},
"WritablePrefix": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritablePrefix"
}
}
},
"required": true
},
"WritableRack": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableRack"
}
}
},
"required": true
},
"WritableRackGroup": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableRackGroup"
}
}
},
"required": true
},
"WritableRackReservation": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableRackReservation"
}
}
},
"required": true
},
"WritableRearPort": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableRearPort"
}
}
},
"required": true
},
"WritableRearPortTemplate": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableRearPortTemplate"
}
}
},
"required": true
},
"WritableRegion": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableRegion"
}
}
},
"required": true
},
"WritableSecret": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableSecret"
}
}
},
"required": true
},
"WritableService": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableService"
}
}
},
"required": true
},
"WritableSite": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableSite"
}
}
},
"required": true
},
"WritableTenant": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableTenant"
}
}
},
"required": true
},
"WritableTenantGroup": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableTenantGroup"
}
}
},
"required": true
},
"WritableVLAN": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableVLAN"
}
}
},
"required": true
},
"WritableVLANGroup": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableVLANGroup"
}
}
},
"required": true
},
"WritableVRF": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableVRF"
}
}
},
"required": true
},
"WritableVirtualChassis": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableVirtualChassis"
}
}
},
"required": true
},
"WritableVirtualMachineInterface": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableVirtualMachineInterface"
}
}
},
"required": true
},
"WritableVirtualMachineWithConfigContext": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableVirtualMachineWithConfigContext"
}
}
},
"required": true
}
},
"schemas": {
"Aggregate": {
"properties": {
"created": {
"format": "date",
"readOnly": true,
"title": "Created",
"type": "string"
},
"custom_fields": {
"default": {},
"title": "Custom fields",
"type": "object"
},
"date_added": {
"format": "date",
"nullable": true,
"title": "Date added",
"type": "string"
},
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"family": {
"properties": {
"label": {
"enum": [
"IPv4",
"IPv6"
],
"type": "string"
},
"value": {
"enum": [
4,
6
],
"type": "integer"
}
},
"readOnly": true,
"required": [
"label",
"value"
],
"title": "Family",
"type": "object"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"last_updated": {
"format": "date-time",
"readOnly": true,
"title": "Last updated",
"type": "string"
},
"prefix": {
"title": "Prefix",
"type": "string"
},
"rir": {
"$ref": "#/components/schemas/NestedRIR"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
}
},
"required": [
"prefix",
"rir"
],
"type": "object"
},
"AvailableIP": {
"properties": {
"address": {
"minLength": 1,
"readOnly": true,
"title": "Address",
"type": "string"
},
"family": {
"readOnly": true,
"title": "Family",
"type": "integer"
},
"vrf": {
"$ref": "#/components/schemas/NestedVRF"
}
},
"type": "object"
},
"AvailablePrefix": {
"properties": {
"family": {
"readOnly": true,
"title": "Family",
"type": "integer"
},
"prefix": {
"minLength": 1,
"readOnly": true,
"title": "Prefix",
"type": "string"
},
"vrf": {
"$ref": "#/components/schemas/NestedVRF"
}
},
"type": "object"
},
"Cable": {
"properties": {
"color": {
"maxLength": 6,
"pattern": "^[0-9a-f]{6}$",
"title": "Color",
"type": "string"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"label": {
"maxLength": 100,
"title": "Label",
"type": "string"
},
"length": {
"maximum": 32767,
"minimum": 0,
"nullable": true,
"title": "Length",
"type": "integer"
},
"length_unit": {
"properties": {
"label": {
"enum": [
"Meters",
"Centimeters",
"Feet",
"Inches"
],
"type": "string"
},
"value": {
"enum": [
"m",
"cm",
"ft",
"in"
],
"type": "string"
}
},
"required": [
"label",
"value"
],
"title": "Length unit",
"type": "object"
},
"status": {
"properties": {
"label": {
"enum": [
"Connected",
"Planned",
"Decommissioning"
],
"type": "string"
},
"value": {
"enum": [
"connected",
"planned",
"decommissioning"
],
"type": "string"
}
},
"required": [
"label",
"value"
],
"title": "Status",
"type": "object"
},
"termination_a": {
"additionalProperties": {
"type": "string"
},
"readOnly": true,
"title": "Termination a",
"type": "object"
},
"termination_a_id": {
"maximum": 2147483647,
"minimum": 0,
"title": "Termination a id",
"type": "integer"
},
"termination_a_type": {
"title": "Termination a type",
"type": "string"
},
"termination_b": {
"additionalProperties": {
"type": "string"
},
"readOnly": true,
"title": "Termination b",
"type": "object"
},
"termination_b_id": {
"maximum": 2147483647,
"minimum": 0,
"title": "Termination b id",
"type": "integer"
},
"termination_b_type": {
"title": "Termination b type",
"type": "string"
},
"type": {
"enum": [
"cat3",
"cat5",
"cat5e",
"cat6",
"cat6a",
"cat7",
"dac-active",
"dac-passive",
"mrj21-trunk",
"coaxial",
"mmf",
"mmf-om1",
"mmf-om2",
"mmf-om3",
"mmf-om4",
"smf",
"smf-os1",
"smf-os2",
"aoc",
"power"
],
"title": "Type",
"type": "string"
}
},
"required": [
"termination_a_type",
"termination_a_id",
"termination_b_type",
"termination_b_id"
],
"type": "object"
},
"Circuit": {
"properties": {
"cid": {
"maxLength": 50,
"minLength": 1,
"title": "Circuit ID",
"type": "string"
},
"comments": {
"title": "Comments",
"type": "string"
},
"commit_rate": {
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"title": "Commit rate (Kbps)",
"type": "integer"
},
"created": {
"format": "date",
"readOnly": true,
"title": "Created",
"type": "string"
},
"custom_fields": {
"default": {},
"title": "Custom fields",
"type": "object"
},
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"install_date": {
"format": "date",
"nullable": true,
"title": "Date installed",
"type": "string"
},
"last_updated": {
"format": "date-time",
"readOnly": true,
"title": "Last updated",
"type": "string"
},
"provider": {
"$ref": "#/components/schemas/NestedProvider"
},
"status": {
"properties": {
"label": {
"enum": [
"Planned",
"Provisioning",
"Active",
"Offline",
"Deprovisioning",
"Decommissioned"
],
"type": "string"
},
"value": {
"enum": [
"planned",
"provisioning",
"active",
"offline",
"deprovisioning",
"decommissioned"
],
"type": "string"
}
},
"required": [
"label",
"value"
],
"title": "Status",
"type": "object"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
},
"tenant": {
"$ref": "#/components/schemas/NestedTenant"
},
"termination_a": {
"$ref": "#/components/schemas/CircuitCircuitTermination"
},
"termination_z": {
"$ref": "#/components/schemas/CircuitCircuitTermination"
},
"type": {
"$ref": "#/components/schemas/NestedCircuitType"
}
},
"required": [
"cid",
"provider",
"type"
],
"type": "object"
},
"CircuitCircuitTermination": {
"properties": {
"connected_endpoint": {
"$ref": "#/components/schemas/NestedInterface"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"port_speed": {
"maximum": 2147483647,
"minimum": 0,
"title": "Port speed (Kbps)",
"type": "integer"
},
"site": {
"$ref": "#/components/schemas/NestedSite"
},
"upstream_speed": {
"description": "Upstream speed, if different from port speed",
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"title": "Upstream speed (Kbps)",
"type": "integer"
},
"url": {
"format": "uri",
"readOnly": true,
"title": "Url",
"type": "string"
},
"xconnect_id": {
"maxLength": 50,
"title": "Cross-connect ID",
"type": "string"
}
},
"required": [
"site",
"connected_endpoint",
"port_speed"
],
"title": "Termination a",
"type": "object"
},
"CircuitTermination": {
"properties": {
"cable": {
"$ref": "#/components/schemas/NestedCable"
},
"circuit": {
"$ref": "#/components/schemas/NestedCircuit"
},
"connected_endpoint": {
"additionalProperties": {
"type": "string"
},
"description": "\nReturn the appropriate serializer for the type of connected object.\n",
"readOnly": true,
"title": "Connected endpoint",
"type": "object"
},
"connected_endpoint_type": {
"readOnly": true,
"title": "Connected endpoint type",
"type": "string"
},
"connection_status": {
"properties": {
"label": {
"enum": [
"Not Connected",
"Connected"
],
"type": "string"
},
"value": {
"enum": [
false,
true
],
"nullable": true,
"type": "boolean"
}
},
"readOnly": true,
"required": [
"label",
"value"
],
"title": "Connection status",
"type": "object"
},
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"port_speed": {
"maximum": 2147483647,
"minimum": 0,
"title": "Port speed (Kbps)",
"type": "integer"
},
"pp_info": {
"maxLength": 100,
"title": "Patch panel/port(s)",
"type": "string"
},
"site": {
"$ref": "#/components/schemas/NestedSite"
},
"term_side": {
"enum": [
"A",
"Z"
],
"title": "Termination",
"type": "string"
},
"upstream_speed": {
"description": "Upstream speed, if different from port speed",
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"title": "Upstream speed (Kbps)",
"type": "integer"
},
"xconnect_id": {
"maxLength": 50,
"title": "Cross-connect ID",
"type": "string"
}
},
"required": [
"circuit",
"term_side",
"site",
"port_speed"
],
"type": "object"
},
"CircuitType": {
"properties": {
"circuit_count": {
"readOnly": true,
"title": "Circuit count",
"type": "integer"
},
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"slug": {
"format": "slug",
"maxLength": 50,
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"title": "Slug",
"type": "string"
}
},
"required": [
"name",
"slug"
],
"type": "object"
},
"Cluster": {
"properties": {
"comments": {
"title": "Comments",
"type": "string"
},
"created": {
"format": "date",
"readOnly": true,
"title": "Created",
"type": "string"
},
"custom_fields": {
"default": {},
"title": "Custom fields",
"type": "object"
},
"device_count": {
"readOnly": true,
"title": "Device count",
"type": "integer"
},
"group": {
"$ref": "#/components/schemas/NestedClusterGroup"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"last_updated": {
"format": "date-time",
"readOnly": true,
"title": "Last updated",
"type": "string"
},
"name": {
"maxLength": 100,
"minLength": 1,
"title": "Name",
"type": "string"
},
"site": {
"$ref": "#/components/schemas/NestedSite"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
},
"tenant": {
"$ref": "#/components/schemas/NestedTenant"
},
"type": {
"$ref": "#/components/schemas/NestedClusterType"
},
"virtualmachine_count": {
"readOnly": true,
"title": "Virtualmachine count",
"type": "integer"
}
},
"required": [
"name",
"type"
],
"type": "object"
},
"ClusterGroup": {
"properties": {
"cluster_count": {
"readOnly": true,
"title": "Cluster count",
"type": "integer"
},
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"slug": {
"format": "slug",
"maxLength": 50,
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"title": "Slug",
"type": "string"
}
},
"required": [
"name",
"slug"
],
"type": "object"
},
"ClusterType": {
"properties": {
"cluster_count": {
"readOnly": true,
"title": "Cluster count",
"type": "integer"
},
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"slug": {
"format": "slug",
"maxLength": 50,
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"title": "Slug",
"type": "string"
}
},
"required": [
"name",
"slug"
],
"type": "object"
},
"ConfigContext": {
"properties": {
"cluster_groups": {
"items": {
"$ref": "#/components/schemas/NestedClusterGroup"
},
"type": "array",
"uniqueItems": true
},
"clusters": {
"items": {
"$ref": "#/components/schemas/NestedCluster"
},
"type": "array",
"uniqueItems": true
},
"data": {
"title": "Data",
"type": "string"
},
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"is_active": {
"title": "Is active",
"type": "boolean"
},
"name": {
"maxLength": 100,
"minLength": 1,
"title": "Name",
"type": "string"
},
"platforms": {
"items": {
"$ref": "#/components/schemas/NestedPlatform"
},
"type": "array",
"uniqueItems": true
},
"regions": {
"items": {
"$ref": "#/components/schemas/NestedRegion"
},
"type": "array",
"uniqueItems": true
},
"roles": {
"items": {
"$ref": "#/components/schemas/NestedDeviceRole"
},
"type": "array",
"uniqueItems": true
},
"sites": {
"items": {
"$ref": "#/components/schemas/NestedSite"
},
"type": "array",
"uniqueItems": true
},
"tags": {
"items": {
"format": "slug",
"pattern": "^[-a-zA-Z0-9_]+$",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"tenant_groups": {
"items": {
"$ref": "#/components/schemas/NestedTenantGroup"
},
"type": "array",
"uniqueItems": true
},
"tenants": {
"items": {
"$ref": "#/components/schemas/NestedTenant"
},
"type": "array",
"uniqueItems": true
},
"weight": {
"maximum": 32767,
"minimum": 0,
"title": "Weight",
"type": "integer"
}
},
"required": [
"name",
"data"
],
"type": "object"
},
"ConsolePort": {
"properties": {
"cable": {
"$ref": "#/components/schemas/NestedCable"
},
"connected_endpoint": {
"additionalProperties": {
"type": "string"
},
"description": "\nReturn the appropriate serializer for the type of connected object.\n",
"readOnly": true,
"title": "Connected endpoint",
"type": "object"
},
"connected_endpoint_type": {
"readOnly": true,
"title": "Connected endpoint type",
"type": "string"
},
"connection_status": {
"properties": {
"label": {
"enum": [
"Not Connected",
"Connected"
],
"type": "string"
},
"value": {
"enum": [
false,
true
],
"nullable": true,
"type": "boolean"
}
},
"readOnly": true,
"required": [
"label",
"value"
],
"title": "Connection status",
"type": "object"
},
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"device": {
"$ref": "#/components/schemas/NestedDevice"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
},
"type": {
"properties": {
"label": {
"enum": [
"DE-9",
"DB-25",
"RJ-11",
"RJ-12",
"RJ-45",
"USB Type A",
"USB Type B",
"USB Type C",
"USB Mini A",
"USB Mini B",
"USB Micro A",
"USB Micro B",
"Other"
],
"type": "string"
},
"value": {
"enum": [
"de-9",
"db-25",
"rj-11",
"rj-12",
"rj-45",
"usb-a",
"usb-b",
"usb-c",
"usb-mini-a",
"usb-mini-b",
"usb-micro-a",
"usb-micro-b",
"other"
],
"type": "string"
}
},
"required": [
"label",
"value"
],
"title": "Type",
"type": "object"
}
},
"required": [
"device",
"name"
],
"type": "object"
},
"ConsolePortTemplate": {
"properties": {
"device_type": {
"$ref": "#/components/schemas/NestedDeviceType"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"type": {
"properties": {
"label": {
"enum": [
"DE-9",
"DB-25",
"RJ-11",
"RJ-12",
"RJ-45",
"USB Type A",
"USB Type B",
"USB Type C",
"USB Mini A",
"USB Mini B",
"USB Micro A",
"USB Micro B",
"Other"
],
"type": "string"
},
"value": {
"enum": [
"de-9",
"db-25",
"rj-11",
"rj-12",
"rj-45",
"usb-a",
"usb-b",
"usb-c",
"usb-mini-a",
"usb-mini-b",
"usb-micro-a",
"usb-micro-b",
"other"
],
"type": "string"
}
},
"required": [
"label",
"value"
],
"title": "Type",
"type": "object"
}
},
"required": [
"device_type",
"name"
],
"type": "object"
},
"ConsoleServerPort": {
"properties": {
"cable": {
"$ref": "#/components/schemas/NestedCable"
},
"connected_endpoint": {
"additionalProperties": {
"type": "string"
},
"description": "\nReturn the appropriate serializer for the type of connected object.\n",
"readOnly": true,
"title": "Connected endpoint",
"type": "object"
},
"connected_endpoint_type": {
"readOnly": true,
"title": "Connected endpoint type",
"type": "string"
},
"connection_status": {
"properties": {
"label": {
"enum": [
"Not Connected",
"Connected"
],
"type": "string"
},
"value": {
"enum": [
false,
true
],
"nullable": true,
"type": "boolean"
}
},
"readOnly": true,
"required": [
"label",
"value"
],
"title": "Connection status",
"type": "object"
},
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"device": {
"$ref": "#/components/schemas/NestedDevice"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
},
"type": {
"properties": {
"label": {
"enum": [
"DE-9",
"DB-25",
"RJ-11",
"RJ-12",
"RJ-45",
"USB Type A",
"USB Type B",
"USB Type C",
"USB Mini A",
"USB Mini B",
"USB Micro A",
"USB Micro B",
"Other"
],
"type": "string"
},
"value": {
"enum": [
"de-9",
"db-25",
"rj-11",
"rj-12",
"rj-45",
"usb-a",
"usb-b",
"usb-c",
"usb-mini-a",
"usb-mini-b",
"usb-micro-a",
"usb-micro-b",
"other"
],
"type": "string"
}
},
"required": [
"label",
"value"
],
"title": "Type",
"type": "object"
}
},
"required": [
"device",
"name"
],
"type": "object"
},
"ConsoleServerPortTemplate": {
"properties": {
"device_type": {
"$ref": "#/components/schemas/NestedDeviceType"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"type": {
"properties": {
"label": {
"enum": [
"DE-9",
"DB-25",
"RJ-11",
"RJ-12",
"RJ-45",
"USB Type A",
"USB Type B",
"USB Type C",
"USB Mini A",
"USB Mini B",
"USB Micro A",
"USB Micro B",
"Other"
],
"type": "string"
},
"value": {
"enum": [
"de-9",
"db-25",
"rj-11",
"rj-12",
"rj-45",
"usb-a",
"usb-b",
"usb-c",
"usb-mini-a",
"usb-mini-b",
"usb-micro-a",
"usb-micro-b",
"other"
],
"type": "string"
}
},
"required": [
"label",
"value"
],
"title": "Type",
"type": "object"
}
},
"required": [
"device_type",
"name"
],
"type": "object"
},
"Device": {
"properties": {
"asset_tag": {
"description": "A unique tag used to identify this device",
"maxLength": 50,
"nullable": true,
"title": "Asset tag",
"type": "string"
},
"cluster": {
"$ref": "#/components/schemas/NestedCluster"
},
"comments": {
"title": "Comments",
"type": "string"
},
"created": {
"format": "date",
"readOnly": true,
"title": "Created",
"type": "string"
},
"custom_fields": {
"default": {},
"title": "Custom fields",
"type": "object"
},
"device_role": {
"$ref": "#/components/schemas/NestedDeviceRole"
},
"device_type": {
"$ref": "#/components/schemas/NestedDeviceType"
},
"display_name": {
"readOnly": true,
"title": "Display name",
"type": "string"
},
"face": {
"properties": {
"label": {
"enum": [
"Front",
"Rear"
],
"type": "string"
},
"value": {
"enum": [
"front",
"rear"
],
"type": "string"
}
},
"required": [
"label",
"value"
],
"title": "Face",
"type": "object"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"last_updated": {
"format": "date-time",
"readOnly": true,
"title": "Last updated",
"type": "string"
},
"local_context_data": {
"nullable": true,
"title": "Local context data",
"type": "string"
},
"name": {
"maxLength": 64,
"nullable": true,
"title": "Name",
"type": "string"
},
"parent_device": {
"$ref": "#/components/schemas/NestedDevice"
},
"platform": {
"$ref": "#/components/schemas/NestedPlatform"
},
"position": {
"description": "The lowest-numbered unit occupied by the device",
"maximum": 32767,
"minimum": 1,
"nullable": true,
"title": "Position (U)",
"type": "integer"
},
"primary_ip": {
"$ref": "#/components/schemas/NestedIPAddress"
},
"primary_ip4": {
"$ref": "#/components/schemas/NestedIPAddress"
},
"primary_ip6": {
"$ref": "#/components/schemas/NestedIPAddress"
},
"rack": {
"$ref": "#/components/schemas/NestedRack"
},
"serial": {
"maxLength": 50,
"title": "Serial number",
"type": "string"
},
"site": {
"$ref": "#/components/schemas/NestedSite"
},
"status": {
"properties": {
"label": {
"enum": [
"Offline",
"Active",
"Planned",
"Staged",
"Failed",
"Inventory",
"Decommissioning"
],
"type": "string"
},
"value": {
"enum": [
"offline",
"active",
"planned",
"staged",
"failed",
"inventory",
"decommissioning"
],
"type": "string"
}
},
"required": [
"label",
"value"
],
"title": "Status",
"type": "object"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
},
"tenant": {
"$ref": "#/components/schemas/NestedTenant"
},
"vc_position": {
"maximum": 255,
"minimum": 0,
"nullable": true,
"title": "Vc position",
"type": "integer"
},
"vc_priority": {
"maximum": 255,
"minimum": 0,
"nullable": true,
"title": "Vc priority",
"type": "integer"
},
"virtual_chassis": {
"$ref": "#/components/schemas/NestedVirtualChassis"
}
},
"required": [
"device_type",
"device_role",
"site"
],
"type": "object"
},
"DeviceBay": {
"properties": {
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"device": {
"$ref": "#/components/schemas/NestedDevice"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"installed_device": {
"$ref": "#/components/schemas/NestedDevice"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
}
},
"required": [
"device",
"name"
],
"type": "object"
},
"DeviceBayTemplate": {
"properties": {
"device_type": {
"$ref": "#/components/schemas/NestedDeviceType"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
}
},
"required": [
"device_type",
"name"
],
"type": "object"
},
"DeviceInterface": {
"properties": {
"cable": {
"$ref": "#/components/schemas/NestedCable"
},
"connected_endpoint": {
"additionalProperties": {
"type": "string"
},
"description": "\nReturn the appropriate serializer for the type of connected object.\n",
"readOnly": true,
"title": "Connected endpoint",
"type": "object"
},
"connected_endpoint_type": {
"readOnly": true,
"title": "Connected endpoint type",
"type": "string"
},
"connection_status": {
"properties": {
"label": {
"enum": [
"Not Connected",
"Connected"
],
"type": "string"
},
"value": {
"enum": [
false,
true
],
"nullable": true,
"type": "boolean"
}
},
"readOnly": true,
"required": [
"label",
"value"
],
"title": "Connection status",
"type": "object"
},
"count_ipaddresses": {
"readOnly": true,
"title": "Count ipaddresses",
"type": "integer"
},
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"device": {
"$ref": "#/components/schemas/NestedDevice"
},
"enabled": {
"title": "Enabled",
"type": "boolean"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"lag": {
"$ref": "#/components/schemas/NestedInterface"
},
"mac_address": {
"nullable": true,
"title": "MAC Address",
"type": "string"
},
"mgmt_only": {
"description": "This interface is used only for out-of-band management",
"title": "OOB Management",
"type": "boolean"
},
"mode": {
"properties": {
"label": {
"enum": [
"Access",
"Tagged",
"Tagged (All)"
],
"type": "string"
},
"value": {
"enum": [
"access",
"tagged",
"tagged-all"
],
"type": "string"
}
},
"required": [
"label",
"value"
],
"title": "Mode",
"type": "object"
},
"mtu": {
"maximum": 65536,
"minimum": 1,
"nullable": true,
"title": "MTU",
"type": "integer"
},
"name": {
"maxLength": 64,
"minLength": 1,
"title": "Name",
"type": "string"
},
"tagged_vlans": {
"items": {
"$ref": "#/components/schemas/NestedVLAN"
},
"type": "array",
"uniqueItems": true
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
},
"type": {
"properties": {
"label": {
"enum": [
"Virtual",
"Link Aggregation Group (LAG)",
"100BASE-TX (10/100ME)",
"1000BASE-T (1GE)",
"2.5GBASE-T (2.5GE)",
"5GBASE-T (5GE)",
"10GBASE-T (10GE)",
"10GBASE-CX4 (10GE)",
"GBIC (1GE)",
"SFP (1GE)",
"SFP+ (10GE)",
"XFP (10GE)",
"XENPAK (10GE)",
"X2 (10GE)",
"SFP28 (25GE)",
"QSFP+ (40GE)",
"QSFP28 (50GE)",
"CFP (100GE)",
"CFP2 (100GE)",
"CFP2 (200GE)",
"CFP4 (100GE)",
"Cisco CPAK (100GE)",
"QSFP28 (100GE)",
"QSFP56 (200GE)",
"QSFP-DD (400GE)",
"OSFP (400GE)",
"IEEE 802.11a",
"IEEE 802.11b/g",
"IEEE 802.11n",
"IEEE 802.11ac",
"IEEE 802.11ad",
"IEEE 802.11ax",
"GSM",
"CDMA",
"LTE",
"OC-3/STM-1",
"OC-12/STM-4",
"OC-48/STM-16",
"OC-192/STM-64",
"OC-768/STM-256",
"OC-1920/STM-640",
"OC-3840/STM-1234",
"SFP (1GFC)",
"SFP (2GFC)",
"SFP (4GFC)",
"SFP+ (8GFC)",
"SFP+ (16GFC)",
"SFP28 (32GFC)",
"QSFP28 (128GFC)",
"SDR (2 Gbps)",
"DDR (4 Gbps)",
"QDR (8 Gbps)",
"FDR10 (10 Gbps)",
"FDR (13.5 Gbps)",
"EDR (25 Gbps)",
"HDR (50 Gbps)",
"NDR (100 Gbps)",
"XDR (250 Gbps)",
"T1 (1.544 Mbps)",
"E1 (2.048 Mbps)",
"T3 (45 Mbps)",
"E3 (34 Mbps)",
"Cisco StackWise",
"Cisco StackWise Plus",
"Cisco FlexStack",
"Cisco FlexStack Plus",
"Juniper VCP",
"Extreme SummitStack",
"Extreme SummitStack-128",
"Extreme SummitStack-256",
"Extreme SummitStack-512",
"Other"
],
"type": "string"
},
"value": {
"enum": [
"virtual",
"lag",
"100base-tx",
"1000base-t",
"2.5gbase-t",
"5gbase-t",
"10gbase-t",
"10gbase-cx4",
"1000base-x-gbic",
"1000base-x-sfp",
"10gbase-x-sfpp",
"10gbase-x-xfp",
"10gbase-x-xenpak",
"10gbase-x-x2",
"25gbase-x-sfp28",
"40gbase-x-qsfpp",
"50gbase-x-sfp28",
"100gbase-x-cfp",
"100gbase-x-cfp2",
"200gbase-x-cfp2",
"100gbase-x-cfp4",
"100gbase-x-cpak",
"100gbase-x-qsfp28",
"200gbase-x-qsfp56",
"400gbase-x-qsfpdd",
"400gbase-x-osfp",
"ieee802.11a",
"ieee802.11g",
"ieee802.11n",
"ieee802.11ac",
"ieee802.11ad",
"ieee802.11ax",
"gsm",
"cdma",
"lte",
"sonet-oc3",
"sonet-oc12",
"sonet-oc48",
"sonet-oc192",
"sonet-oc768",
"sonet-oc1920",
"sonet-oc3840",
"1gfc-sfp",
"2gfc-sfp",
"4gfc-sfp",
"8gfc-sfpp",
"16gfc-sfpp",
"32gfc-sfp28",
"128gfc-sfp28",
"infiniband-sdr",
"infiniband-ddr",
"infiniband-qdr",
"infiniband-fdr10",
"infiniband-fdr",
"infiniband-edr",
"infiniband-hdr",
"infiniband-ndr",
"infiniband-xdr",
"t1",
"e1",
"t3",
"e3",
"cisco-stackwise",
"cisco-stackwise-plus",
"cisco-flexstack",
"cisco-flexstack-plus",
"juniper-vcp",
"extreme-summitstack",
"extreme-summitstack-128",
"extreme-summitstack-256",
"extreme-summitstack-512",
"other"
],
"type": "string"
}
},
"required": [
"label",
"value"
],
"title": "Type",
"type": "object"
},
"untagged_vlan": {
"$ref": "#/components/schemas/NestedVLAN"
}
},
"required": [
"device",
"name",
"type"
],
"type": "object"
},
"DeviceNAPALM": {
"properties": {
"method": {
"additionalProperties": {
"type": "string"
},
"title": "Method",
"type": "object"
}
},
"required": [
"method"
],
"type": "object"
},
"DeviceRole": {
"properties": {
"color": {
"maxLength": 6,
"minLength": 1,
"pattern": "^[0-9a-f]{6}$",
"title": "Color",
"type": "string"
},
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"device_count": {
"readOnly": true,
"title": "Device count",
"type": "integer"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"slug": {
"format": "slug",
"maxLength": 50,
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"title": "Slug",
"type": "string"
},
"virtualmachine_count": {
"readOnly": true,
"title": "Virtualmachine count",
"type": "integer"
},
"vm_role": {
"description": "Virtual machines may be assigned to this role",
"title": "VM Role",
"type": "boolean"
}
},
"required": [
"name",
"slug"
],
"type": "object"
},
"DeviceType": {
"properties": {
"comments": {
"title": "Comments",
"type": "string"
},
"created": {
"format": "date",
"readOnly": true,
"title": "Created",
"type": "string"
},
"custom_fields": {
"default": {},
"title": "Custom fields",
"type": "object"
},
"device_count": {
"readOnly": true,
"title": "Device count",
"type": "integer"
},
"display_name": {
"readOnly": true,
"title": "Display name",
"type": "string"
},
"front_image": {
"format": "uri",
"readOnly": true,
"title": "Front image",
"type": "string"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"is_full_depth": {
"description": "Device consumes both front and rear rack faces",
"title": "Is full depth",
"type": "boolean"
},
"last_updated": {
"format": "date-time",
"readOnly": true,
"title": "Last updated",
"type": "string"
},
"manufacturer": {
"$ref": "#/components/schemas/NestedManufacturer"
},
"model": {
"maxLength": 50,
"minLength": 1,
"title": "Model",
"type": "string"
},
"part_number": {
"description": "Discrete part number (optional)",
"maxLength": 50,
"title": "Part number",
"type": "string"
},
"rear_image": {
"format": "uri",
"readOnly": true,
"title": "Rear image",
"type": "string"
},
"slug": {
"format": "slug",
"maxLength": 50,
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"title": "Slug",
"type": "string"
},
"subdevice_role": {
"properties": {
"label": {
"enum": [
"Parent",
"Child"
],
"type": "string"
},
"value": {
"enum": [
"parent",
"child"
],
"type": "string"
}
},
"required": [
"label",
"value"
],
"title": "Subdevice role",
"type": "object"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
},
"u_height": {
"maximum": 32767,
"minimum": 0,
"title": "Height (U)",
"type": "integer"
}
},
"required": [
"manufacturer",
"model",
"slug"
],
"type": "object"
},
"DeviceWithConfigContext": {
"properties": {
"asset_tag": {
"description": "A unique tag used to identify this device",
"maxLength": 50,
"nullable": true,
"title": "Asset tag",
"type": "string"
},
"cluster": {
"$ref": "#/components/schemas/NestedCluster"
},
"comments": {
"title": "Comments",
"type": "string"
},
"config_context": {
"additionalProperties": {
"type": "string"
},
"readOnly": true,
"title": "Config context",
"type": "object"
},
"created": {
"format": "date",
"readOnly": true,
"title": "Created",
"type": "string"
},
"custom_fields": {
"default": {},
"title": "Custom fields",
"type": "object"
},
"device_role": {
"$ref": "#/components/schemas/NestedDeviceRole"
},
"device_type": {
"$ref": "#/components/schemas/NestedDeviceType"
},
"display_name": {
"readOnly": true,
"title": "Display name",
"type": "string"
},
"face": {
"properties": {
"label": {
"enum": [
"Front",
"Rear"
],
"type": "string"
},
"value": {
"enum": [
"front",
"rear"
],
"type": "string"
}
},
"required": [
"label",
"value"
],
"title": "Face",
"type": "object"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"last_updated": {
"format": "date-time",
"readOnly": true,
"title": "Last updated",
"type": "string"
},
"local_context_data": {
"nullable": true,
"title": "Local context data",
"type": "string"
},
"name": {
"maxLength": 64,
"nullable": true,
"title": "Name",
"type": "string"
},
"parent_device": {
"$ref": "#/components/schemas/NestedDevice"
},
"platform": {
"$ref": "#/components/schemas/NestedPlatform"
},
"position": {
"description": "The lowest-numbered unit occupied by the device",
"maximum": 32767,
"minimum": 1,
"nullable": true,
"title": "Position (U)",
"type": "integer"
},
"primary_ip": {
"$ref": "#/components/schemas/NestedIPAddress"
},
"primary_ip4": {
"$ref": "#/components/schemas/NestedIPAddress"
},
"primary_ip6": {
"$ref": "#/components/schemas/NestedIPAddress"
},
"rack": {
"$ref": "#/components/schemas/NestedRack"
},
"serial": {
"maxLength": 50,
"title": "Serial number",
"type": "string"
},
"site": {
"$ref": "#/components/schemas/NestedSite"
},
"status": {
"properties": {
"label": {
"enum": [
"Offline",
"Active",
"Planned",
"Staged",
"Failed",
"Inventory",
"Decommissioning"
],
"type": "string"
},
"value": {
"enum": [
"offline",
"active",
"planned",
"staged",
"failed",
"inventory",
"decommissioning"
],
"type": "string"
}
},
"required": [
"label",
"value"
],
"title": "Status",
"type": "object"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
},
"tenant": {
"$ref": "#/components/schemas/NestedTenant"
},
"vc_position": {
"maximum": 255,
"minimum": 0,
"nullable": true,
"title": "Vc position",
"type": "integer"
},
"vc_priority": {
"maximum": 255,
"minimum": 0,
"nullable": true,
"title": "Vc priority",
"type": "integer"
},
"virtual_chassis": {
"$ref": "#/components/schemas/NestedVirtualChassis"
}
},
"required": [
"device_type",
"device_role",
"site"
],
"type": "object"
},
"ExportTemplate": {
"properties": {
"content_type": {
"title": "Content type",
"type": "string"
},
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"file_extension": {
"description": "Extension to append to the rendered filename",
"maxLength": 15,
"title": "File extension",
"type": "string"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"mime_type": {
"description": "Defaults to <code>text/plain</code>",
"maxLength": 50,
"title": "MIME type",
"type": "string"
},
"name": {
"maxLength": 100,
"minLength": 1,
"title": "Name",
"type": "string"
},
"template_code": {
"description": "The list of objects being exported is passed as a context variable named <code>queryset</code>.",
"minLength": 1,
"title": "Template code",
"type": "string"
},
"template_language": {
"default": {
"id": 20,
"label": "Jinja2",
"value": "jinja2"
},
"properties": {
"label": {
"enum": [
"Django",
"Jinja2"
],
"type": "string"
},
"value": {
"enum": [
"django",
"jinja2"
],
"type": "string"
}
},
"required": [
"label",
"value"
],
"title": "Template language",
"type": "object"
}
},
"required": [
"content_type",
"name",
"template_code"
],
"type": "object"
},
"FrontPort": {
"properties": {
"cable": {
"$ref": "#/components/schemas/NestedCable"
},
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"device": {
"$ref": "#/components/schemas/NestedDevice"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 64,
"minLength": 1,
"title": "Name",
"type": "string"
},
"rear_port": {
"$ref": "#/components/schemas/FrontPortRearPort"
},
"rear_port_position": {
"default": 1,
"maximum": 64,
"minimum": 1,
"title": "Rear port position",
"type": "integer"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
},
"type": {
"properties": {
"label": {
"enum": [
"8P8C",
"110 Punch",
"BNC",
"MRJ21",
"FC",
"LC",
"LC/APC",
"LSH",
"LSH/APC",
"MPO",
"MTRJ",
"SC",
"SC/APC",
"ST"
],
"type": "string"
},
"value": {
"enum": [
"8p8c",
"110-punch",
"bnc",
"mrj21",
"fc",
"lc",
"lc-apc",
"lsh",
"lsh-apc",
"mpo",
"mtrj",
"sc",
"sc-apc",
"st"
],
"type": "string"
}
},
"required": [
"label",
"value"
],
"title": "Type",
"type": "object"
}
},
"required": [
"device",
"name",
"type",
"rear_port"
],
"type": "object"
},
"FrontPortRearPort": {
"properties": {
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 64,
"minLength": 1,
"title": "Name",
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"title": "Url",
"type": "string"
}
},
"required": [
"name"
],
"title": "Rear port",
"type": "object"
},
"FrontPortTemplate": {
"properties": {
"device_type": {
"$ref": "#/components/schemas/NestedDeviceType"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 64,
"minLength": 1,
"title": "Name",
"type": "string"
},
"rear_port": {
"$ref": "#/components/schemas/NestedRearPortTemplate"
},
"rear_port_position": {
"default": 1,
"maximum": 64,
"minimum": 1,
"title": "Rear port position",
"type": "integer"
},
"type": {
"properties": {
"label": {
"enum": [
"8P8C",
"110 Punch",
"BNC",
"MRJ21",
"FC",
"LC",
"LC/APC",
"LSH",
"LSH/APC",
"MPO",
"MTRJ",
"SC",
"SC/APC",
"ST"
],
"type": "string"
},
"value": {
"enum": [
"8p8c",
"110-punch",
"bnc",
"mrj21",
"fc",
"lc",
"lc-apc",
"lsh",
"lsh-apc",
"mpo",
"mtrj",
"sc",
"sc-apc",
"st"
],
"type": "string"
}
},
"required": [
"label",
"value"
],
"title": "Type",
"type": "object"
}
},
"required": [
"device_type",
"name",
"type",
"rear_port"
],
"type": "object"
},
"Graph": {
"properties": {
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"link": {
"format": "uri",
"maxLength": 200,
"title": "Link URL",
"type": "string"
},
"name": {
"maxLength": 100,
"minLength": 1,
"title": "Name",
"type": "string"
},
"source": {
"maxLength": 500,
"minLength": 1,
"title": "Source URL",
"type": "string"
},
"template_language": {
"enum": [
"django",
"jinja2"
],
"title": "Template language",
"type": "string"
},
"type": {
"title": "Type",
"type": "string"
},
"weight": {
"maximum": 32767,
"minimum": 0,
"title": "Weight",
"type": "integer"
}
},
"required": [
"type",
"name",
"source"
],
"type": "object"
},
"IPAddress": {
"properties": {
"address": {
"description": "IPv4 or IPv6 address (with mask)",
"title": "Address",
"type": "string"
},
"created": {
"format": "date",
"readOnly": true,
"title": "Created",
"type": "string"
},
"custom_fields": {
"default": {},
"title": "Custom fields",
"type": "object"
},
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"dns_name": {
"description": "Hostname or FQDN (not case-sensitive)",
"maxLength": 255,
"pattern": "^[0-9A-Za-z._-]+$",
"title": "DNS Name",
"type": "string"
},
"family": {
"properties": {
"label": {
"enum": [
"IPv4",
"IPv6"
],
"type": "string"
},
"value": {
"enum": [
4,
6
],
"type": "integer"
}
},
"readOnly": true,
"required": [
"label",
"value"
],
"title": "Family",
"type": "object"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"interface": {
"$ref": "#/components/schemas/IPAddressInterface"
},
"last_updated": {
"format": "date-time",
"readOnly": true,
"title": "Last updated",
"type": "string"
},
"nat_inside": {
"$ref": "#/components/schemas/NestedIPAddress"
},
"nat_outside": {
"$ref": "#/components/schemas/NestedIPAddress"
},
"role": {
"properties": {
"label": {
"enum": [
"Loopback",
"Secondary",
"Anycast",
"VIP",
"VRRP",
"HSRP",
"GLBP",
"CARP"
],
"type": "string"
},
"value": {
"enum": [
"loopback",
"secondary",
"anycast",
"vip",
"vrrp",
"hsrp",
"glbp",
"carp"
],
"type": "string"
}
},
"required": [
"label",
"value"
],
"title": "Role",
"type": "object"
},
"status": {
"properties": {
"label": {
"enum": [
"Active",
"Reserved",
"Deprecated",
"DHCP"
],
"type": "string"
},
"value": {
"enum": [
"active",
"reserved",
"deprecated",
"dhcp"
],
"type": "string"
}
},
"required": [
"label",
"value"
],
"title": "Status",
"type": "object"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
},
"tenant": {
"$ref": "#/components/schemas/NestedTenant"
},
"vrf": {
"$ref": "#/components/schemas/NestedVRF"
}
},
"required": [
"address"
],
"type": "object"
},
"IPAddressInterface": {
"properties": {
"device": {
"$ref": "#/components/schemas/NestedDevice"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 64,
"minLength": 1,
"title": "Name",
"type": "string"
},
"url": {
"readOnly": true,
"title": "Url",
"type": "string"
},
"virtual_machine": {
"$ref": "#/components/schemas/NestedVirtualMachine"
}
},
"required": [
"name"
],
"title": "Interface",
"type": "object"
},
"ImageAttachment": {
"properties": {
"content_type": {
"title": "Content type",
"type": "string"
},
"created": {
"format": "date-time",
"readOnly": true,
"title": "Created",
"type": "string"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"image": {
"format": "uri",
"readOnly": true,
"title": "Image",
"type": "string"
},
"image_height": {
"maximum": 32767,
"minimum": 0,
"title": "Image height",
"type": "integer"
},
"image_width": {
"maximum": 32767,
"minimum": 0,
"title": "Image width",
"type": "integer"
},
"name": {
"maxLength": 50,
"title": "Name",
"type": "string"
},
"object_id": {
"maximum": 2147483647,
"minimum": 0,
"title": "Object id",
"type": "integer"
},
"parent": {
"additionalProperties": {
"type": "string"
},
"readOnly": true,
"title": "Parent",
"type": "object"
}
},
"required": [
"content_type",
"object_id",
"image_height",
"image_width"
],
"type": "object"
},
"InterfaceConnection": {
"properties": {
"connection_status": {
"properties": {
"label": {
"enum": [
"Not Connected",
"Connected"
],
"type": "string"
},
"value": {
"enum": [
false,
true
],
"nullable": true,
"type": "boolean"
}
},
"required": [
"label",
"value"
],
"title": "Connection status",
"type": "object"
},
"interface_a": {
"$ref": "#/components/schemas/NestedInterface"
},
"interface_b": {
"$ref": "#/components/schemas/NestedInterface"
}
},
"required": [
"interface_b"
],
"type": "object"
},
"InterfaceTemplate": {
"properties": {
"device_type": {
"$ref": "#/components/schemas/NestedDeviceType"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"mgmt_only": {
"title": "Management only",
"type": "boolean"
},
"name": {
"maxLength": 64,
"minLength": 1,
"title": "Name",
"type": "string"
},
"type": {
"properties": {
"label": {
"enum": [
"Virtual",
"Link Aggregation Group (LAG)",
"100BASE-TX (10/100ME)",
"1000BASE-T (1GE)",
"2.5GBASE-T (2.5GE)",
"5GBASE-T (5GE)",
"10GBASE-T (10GE)",
"10GBASE-CX4 (10GE)",
"GBIC (1GE)",
"SFP (1GE)",
"SFP+ (10GE)",
"XFP (10GE)",
"XENPAK (10GE)",
"X2 (10GE)",
"SFP28 (25GE)",
"QSFP+ (40GE)",
"QSFP28 (50GE)",
"CFP (100GE)",
"CFP2 (100GE)",
"CFP2 (200GE)",
"CFP4 (100GE)",
"Cisco CPAK (100GE)",
"QSFP28 (100GE)",
"QSFP56 (200GE)",
"QSFP-DD (400GE)",
"OSFP (400GE)",
"IEEE 802.11a",
"IEEE 802.11b/g",
"IEEE 802.11n",
"IEEE 802.11ac",
"IEEE 802.11ad",
"IEEE 802.11ax",
"GSM",
"CDMA",
"LTE",
"OC-3/STM-1",
"OC-12/STM-4",
"OC-48/STM-16",
"OC-192/STM-64",
"OC-768/STM-256",
"OC-1920/STM-640",
"OC-3840/STM-1234",
"SFP (1GFC)",
"SFP (2GFC)",
"SFP (4GFC)",
"SFP+ (8GFC)",
"SFP+ (16GFC)",
"SFP28 (32GFC)",
"QSFP28 (128GFC)",
"SDR (2 Gbps)",
"DDR (4 Gbps)",
"QDR (8 Gbps)",
"FDR10 (10 Gbps)",
"FDR (13.5 Gbps)",
"EDR (25 Gbps)",
"HDR (50 Gbps)",
"NDR (100 Gbps)",
"XDR (250 Gbps)",
"T1 (1.544 Mbps)",
"E1 (2.048 Mbps)",
"T3 (45 Mbps)",
"E3 (34 Mbps)",
"Cisco StackWise",
"Cisco StackWise Plus",
"Cisco FlexStack",
"Cisco FlexStack Plus",
"Juniper VCP",
"Extreme SummitStack",
"Extreme SummitStack-128",
"Extreme SummitStack-256",
"Extreme SummitStack-512",
"Other"
],
"type": "string"
},
"value": {
"enum": [
"virtual",
"lag",
"100base-tx",
"1000base-t",
"2.5gbase-t",
"5gbase-t",
"10gbase-t",
"10gbase-cx4",
"1000base-x-gbic",
"1000base-x-sfp",
"10gbase-x-sfpp",
"10gbase-x-xfp",
"10gbase-x-xenpak",
"10gbase-x-x2",
"25gbase-x-sfp28",
"40gbase-x-qsfpp",
"50gbase-x-sfp28",
"100gbase-x-cfp",
"100gbase-x-cfp2",
"200gbase-x-cfp2",
"100gbase-x-cfp4",
"100gbase-x-cpak",
"100gbase-x-qsfp28",
"200gbase-x-qsfp56",
"400gbase-x-qsfpdd",
"400gbase-x-osfp",
"ieee802.11a",
"ieee802.11g",
"ieee802.11n",
"ieee802.11ac",
"ieee802.11ad",
"ieee802.11ax",
"gsm",
"cdma",
"lte",
"sonet-oc3",
"sonet-oc12",
"sonet-oc48",
"sonet-oc192",
"sonet-oc768",
"sonet-oc1920",
"sonet-oc3840",
"1gfc-sfp",
"2gfc-sfp",
"4gfc-sfp",
"8gfc-sfpp",
"16gfc-sfpp",
"32gfc-sfp28",
"128gfc-sfp28",
"infiniband-sdr",
"infiniband-ddr",
"infiniband-qdr",
"infiniband-fdr10",
"infiniband-fdr",
"infiniband-edr",
"infiniband-hdr",
"infiniband-ndr",
"infiniband-xdr",
"t1",
"e1",
"t3",
"e3",
"cisco-stackwise",
"cisco-stackwise-plus",
"cisco-flexstack",
"cisco-flexstack-plus",
"juniper-vcp",
"extreme-summitstack",
"extreme-summitstack-128",
"extreme-summitstack-256",
"extreme-summitstack-512",
"other"
],
"type": "string"
}
},
"required": [
"label",
"value"
],
"title": "Type",
"type": "object"
}
},
"required": [
"device_type",
"name",
"type"
],
"type": "object"
},
"InventoryItem": {
"properties": {
"asset_tag": {
"description": "A unique tag used to identify this item",
"maxLength": 50,
"nullable": true,
"title": "Asset tag",
"type": "string"
},
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"device": {
"$ref": "#/components/schemas/NestedDevice"
},
"discovered": {
"description": "This item was automatically discovered",
"title": "Discovered",
"type": "boolean"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"manufacturer": {
"$ref": "#/components/schemas/NestedManufacturer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"parent": {
"nullable": true,
"title": "Parent",
"type": "integer"
},
"part_id": {
"description": "Manufacturer-assigned part identifier",
"maxLength": 50,
"title": "Part ID",
"type": "string"
},
"serial": {
"maxLength": 50,
"title": "Serial number",
"type": "string"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
}
},
"required": [
"device",
"name"
],
"type": "object"
},
"Manufacturer": {
"properties": {
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"devicetype_count": {
"readOnly": true,
"title": "Devicetype count",
"type": "integer"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"inventoryitem_count": {
"readOnly": true,
"title": "Inventoryitem count",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"platform_count": {
"readOnly": true,
"title": "Platform count",
"type": "integer"
},
"slug": {
"format": "slug",
"maxLength": 50,
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"title": "Slug",
"type": "string"
}
},
"required": [
"name",
"slug"
],
"type": "object"
},
"NestedCable": {
"properties": {
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"label": {
"maxLength": 100,
"title": "Label",
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"title": "Url",
"type": "string"
}
},
"title": "Cable",
"type": "object"
},
"NestedCircuit": {
"properties": {
"cid": {
"maxLength": 50,
"minLength": 1,
"title": "Circuit ID",
"type": "string"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"url": {
"format": "uri",
"readOnly": true,
"title": "Url",
"type": "string"
}
},
"required": [
"cid"
],
"title": "Circuit",
"type": "object"
},
"NestedCircuitType": {
"properties": {
"circuit_count": {
"readOnly": true,
"title": "Circuit count",
"type": "integer"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"slug": {
"format": "slug",
"maxLength": 50,
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"title": "Slug",
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"title": "Url",
"type": "string"
}
},
"required": [
"name",
"slug"
],
"title": "Type",
"type": "object"
},
"NestedCluster": {
"properties": {
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 100,
"minLength": 1,
"title": "Name",
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"title": "Url",
"type": "string"
},
"virtualmachine_count": {
"readOnly": true,
"title": "Virtualmachine count",
"type": "integer"
}
},
"required": [
"name"
],
"title": "Cluster",
"type": "object"
},
"NestedClusterGroup": {
"properties": {
"cluster_count": {
"readOnly": true,
"title": "Cluster count",
"type": "integer"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"slug": {
"format": "slug",
"maxLength": 50,
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"title": "Slug",
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"title": "Url",
"type": "string"
}
},
"required": [
"name",
"slug"
],
"type": "object"
},
"NestedClusterType": {
"properties": {
"cluster_count": {
"readOnly": true,
"title": "Cluster count",
"type": "integer"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"slug": {
"format": "slug",
"maxLength": 50,
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"title": "Slug",
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"title": "Url",
"type": "string"
}
},
"required": [
"name",
"slug"
],
"title": "Type",
"type": "object"
},
"NestedDevice": {
"properties": {
"display_name": {
"readOnly": true,
"title": "Display name",
"type": "string"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 64,
"nullable": true,
"title": "Name",
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"title": "Url",
"type": "string"
}
},
"title": "Device",
"type": "object"
},
"NestedDeviceRole": {
"properties": {
"device_count": {
"readOnly": true,
"title": "Device count",
"type": "integer"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"slug": {
"format": "slug",
"maxLength": 50,
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"title": "Slug",
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"title": "Url",
"type": "string"
},
"virtualmachine_count": {
"readOnly": true,
"title": "Virtualmachine count",
"type": "integer"
}
},
"required": [
"name",
"slug"
],
"title": "Device role",
"type": "object"
},
"NestedDeviceType": {
"properties": {
"device_count": {
"readOnly": true,
"title": "Device count",
"type": "integer"
},
"display_name": {
"readOnly": true,
"title": "Display name",
"type": "string"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"manufacturer": {
"$ref": "#/components/schemas/NestedManufacturer"
},
"model": {
"maxLength": 50,
"minLength": 1,
"title": "Model",
"type": "string"
},
"slug": {
"format": "slug",
"maxLength": 50,
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"title": "Slug",
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"title": "Url",
"type": "string"
}
},
"required": [
"model",
"slug"
],
"title": "Device type",
"type": "object"
},
"NestedIPAddress": {
"properties": {
"address": {
"description": "IPv4 or IPv6 address (with mask)",
"title": "Address",
"type": "string"
},
"family": {
"readOnly": true,
"title": "Family",
"type": "string"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"url": {
"format": "uri",
"readOnly": true,
"title": "Url",
"type": "string"
}
},
"required": [
"address"
],
"title": "Primary ip",
"type": "object"
},
"NestedInterface": {
"properties": {
"cable": {
"nullable": true,
"title": "Cable",
"type": "integer"
},
"connection_status": {
"properties": {
"label": {
"enum": [
"Not Connected",
"Connected"
],
"type": "string"
},
"value": {
"enum": [
false,
true
],
"nullable": true,
"type": "boolean"
}
},
"readOnly": true,
"required": [
"label",
"value"
],
"title": "Connection status",
"type": "object"
},
"device": {
"$ref": "#/components/schemas/NestedDevice"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 64,
"minLength": 1,
"title": "Name",
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"title": "Url",
"type": "string"
}
},
"required": [
"name"
],
"title": "Connected endpoint",
"type": "object"
},
"NestedManufacturer": {
"properties": {
"devicetype_count": {
"readOnly": true,
"title": "Devicetype count",
"type": "integer"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"slug": {
"format": "slug",
"maxLength": 50,
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"title": "Slug",
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"title": "Url",
"type": "string"
}
},
"required": [
"name",
"slug"
],
"title": "Manufacturer",
"type": "object"
},
"NestedPlatform": {
"properties": {
"device_count": {
"readOnly": true,
"title": "Device count",
"type": "integer"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 100,
"minLength": 1,
"title": "Name",
"type": "string"
},
"slug": {
"format": "slug",
"maxLength": 100,
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"title": "Slug",
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"title": "Url",
"type": "string"
},
"virtualmachine_count": {
"readOnly": true,
"title": "Virtualmachine count",
"type": "integer"
}
},
"required": [
"name",
"slug"
],
"title": "Platform",
"type": "object"
},
"NestedPowerPanel": {
"properties": {
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"powerfeed_count": {
"readOnly": true,
"title": "Powerfeed count",
"type": "integer"
},
"url": {
"format": "uri",
"readOnly": true,
"title": "Url",
"type": "string"
}
},
"required": [
"name"
],
"title": "Power panel",
"type": "object"
},
"NestedPowerPort": {
"properties": {
"cable": {
"nullable": true,
"title": "Cable",
"type": "integer"
},
"connection_status": {
"properties": {
"label": {
"enum": [
"Not Connected",
"Connected"
],
"type": "string"
},
"value": {
"enum": [
false,
true
],
"nullable": true,
"type": "boolean"
}
},
"readOnly": true,
"required": [
"label",
"value"
],
"title": "Connection status",
"type": "object"
},
"device": {
"$ref": "#/components/schemas/NestedDevice"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"title": "Url",
"type": "string"
}
},
"required": [
"name"
],
"title": "Power port",
"type": "object"
},
"NestedPowerPortTemplate": {
"properties": {
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"title": "Url",
"type": "string"
}
},
"required": [
"name"
],
"title": "Power port",
"type": "object"
},
"NestedProvider": {
"properties": {
"circuit_count": {
"readOnly": true,
"title": "Circuit count",
"type": "integer"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"slug": {
"format": "slug",
"maxLength": 50,
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"title": "Slug",
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"title": "Url",
"type": "string"
}
},
"required": [
"name",
"slug"
],
"title": "Provider",
"type": "object"
},
"NestedRIR": {
"properties": {
"aggregate_count": {
"readOnly": true,
"title": "Aggregate count",
"type": "integer"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"slug": {
"format": "slug",
"maxLength": 50,
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"title": "Slug",
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"title": "Url",
"type": "string"
}
},
"required": [
"name",
"slug"
],
"title": "Rir",
"type": "object"
},
"NestedRack": {
"properties": {
"device_count": {
"readOnly": true,
"title": "Device count",
"type": "integer"
},
"display_name": {
"readOnly": true,
"title": "Display name",
"type": "string"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"title": "Url",
"type": "string"
}
},
"required": [
"name"
],
"title": "Rack",
"type": "object"
},
"NestedRackGroup": {
"properties": {
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"rack_count": {
"readOnly": true,
"title": "Rack count",
"type": "integer"
},
"slug": {
"format": "slug",
"maxLength": 50,
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"title": "Slug",
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"title": "Url",
"type": "string"
}
},
"required": [
"name",
"slug"
],
"title": "Rack group",
"type": "object"
},
"NestedRackRole": {
"properties": {
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"rack_count": {
"readOnly": true,
"title": "Rack count",
"type": "integer"
},
"slug": {
"format": "slug",
"maxLength": 50,
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"title": "Slug",
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"title": "Url",
"type": "string"
}
},
"required": [
"name",
"slug"
],
"title": "Role",
"type": "object"
},
"NestedRearPortTemplate": {
"properties": {
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 64,
"minLength": 1,
"title": "Name",
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"title": "Url",
"type": "string"
}
},
"required": [
"name"
],
"title": "Rear port",
"type": "object"
},
"NestedRegion": {
"properties": {
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"site_count": {
"readOnly": true,
"title": "Site count",
"type": "integer"
},
"slug": {
"format": "slug",
"maxLength": 50,
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"title": "Slug",
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"title": "Url",
"type": "string"
}
},
"required": [
"name",
"slug"
],
"title": "Parent",
"type": "object"
},
"NestedRole": {
"properties": {
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"prefix_count": {
"readOnly": true,
"title": "Prefix count",
"type": "integer"
},
"slug": {
"format": "slug",
"maxLength": 50,
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"title": "Slug",
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"title": "Url",
"type": "string"
},
"vlan_count": {
"readOnly": true,
"title": "Vlan count",
"type": "integer"
}
},
"required": [
"name",
"slug"
],
"title": "Role",
"type": "object"
},
"NestedSecretRole": {
"properties": {
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"secret_count": {
"readOnly": true,
"title": "Secret count",
"type": "integer"
},
"slug": {
"format": "slug",
"maxLength": 50,
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"title": "Slug",
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"title": "Url",
"type": "string"
}
},
"required": [
"name",
"slug"
],
"title": "Role",
"type": "object"
},
"NestedSite": {
"properties": {
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"slug": {
"format": "slug",
"maxLength": 50,
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"title": "Slug",
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"title": "Url",
"type": "string"
}
},
"required": [
"name",
"slug"
],
"title": "Site",
"type": "object"
},
"NestedTenant": {
"properties": {
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 30,
"minLength": 1,
"title": "Name",
"type": "string"
},
"slug": {
"format": "slug",
"maxLength": 50,
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"title": "Slug",
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"title": "Url",
"type": "string"
}
},
"required": [
"name",
"slug"
],
"title": "Tenant",
"type": "object"
},
"NestedTenantGroup": {
"properties": {
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"slug": {
"format": "slug",
"maxLength": 50,
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"title": "Slug",
"type": "string"
},
"tenant_count": {
"readOnly": true,
"title": "Tenant count",
"type": "integer"
},
"url": {
"format": "uri",
"readOnly": true,
"title": "Url",
"type": "string"
}
},
"required": [
"name",
"slug"
],
"type": "object"
},
"NestedUser": {
"properties": {
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"username": {
"description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
"maxLength": 150,
"minLength": 1,
"pattern": "^[\\w.@+-]+$",
"title": "Username",
"type": "string"
}
},
"required": [
"username"
],
"title": "User",
"type": "object"
},
"NestedVLAN": {
"properties": {
"display_name": {
"readOnly": true,
"title": "Display name",
"type": "string"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 64,
"minLength": 1,
"title": "Name",
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"title": "Url",
"type": "string"
},
"vid": {
"maximum": 4094,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"required": [
"vid",
"name"
],
"title": "Untagged vlan",
"type": "object"
},
"NestedVLANGroup": {
"properties": {
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"slug": {
"format": "slug",
"maxLength": 50,
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"title": "Slug",
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"title": "Url",
"type": "string"
},
"vlan_count": {
"readOnly": true,
"title": "Vlan count",
"type": "integer"
}
},
"required": [
"name",
"slug"
],
"title": "Group",
"type": "object"
},
"NestedVRF": {
"properties": {
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"prefix_count": {
"readOnly": true,
"title": "Prefix count",
"type": "integer"
},
"rd": {
"description": "Unique route distinguisher (as defined in RFC 4364)",
"maxLength": 21,
"nullable": true,
"title": "Route distinguisher",
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"title": "Url",
"type": "string"
}
},
"required": [
"name"
],
"title": "Vrf",
"type": "object"
},
"NestedVirtualChassis": {
"properties": {
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"master": {
"$ref": "#/components/schemas/NestedDevice"
},
"member_count": {
"readOnly": true,
"title": "Member count",
"type": "integer"
},
"url": {
"format": "uri",
"readOnly": true,
"title": "Url",
"type": "string"
}
},
"required": [
"master"
],
"title": "Virtual chassis",
"type": "object"
},
"NestedVirtualMachine": {
"properties": {
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 64,
"minLength": 1,
"title": "Name",
"type": "string"
},
"url": {
"format": "uri",
"readOnly": true,
"title": "Url",
"type": "string"
}
},
"required": [
"name"
],
"title": "Virtual machine",
"type": "object"
},
"ObjectChange": {
"properties": {
"action": {
"properties": {
"label": {
"enum": [
"Created",
"Updated",
"Deleted"
],
"type": "string"
},
"value": {
"enum": [
"create",
"update",
"delete"
],
"type": "string"
}
},
"readOnly": true,
"required": [
"label",
"value"
],
"title": "Action",
"type": "object"
},
"changed_object": {
"additionalProperties": {
"type": "string"
},
"description": "\nSerialize a nested representation of the changed object.\n",
"readOnly": true,
"title": "Changed object",
"type": "object"
},
"changed_object_id": {
"maximum": 2147483647,
"minimum": 0,
"title": "Changed object id",
"type": "integer"
},
"changed_object_type": {
"readOnly": true,
"title": "Changed object type",
"type": "string"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"object_data": {
"readOnly": true,
"title": "Object data",
"type": "string"
},
"request_id": {
"format": "uuid",
"readOnly": true,
"title": "Request id",
"type": "string"
},
"time": {
"format": "date-time",
"readOnly": true,
"title": "Time",
"type": "string"
},
"user": {
"$ref": "#/components/schemas/NestedUser"
},
"user_name": {
"minLength": 1,
"readOnly": true,
"title": "User name",
"type": "string"
}
},
"required": [
"changed_object_id"
],
"type": "object"
},
"Platform": {
"properties": {
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"device_count": {
"readOnly": true,
"title": "Device count",
"type": "integer"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"manufacturer": {
"$ref": "#/components/schemas/NestedManufacturer"
},
"name": {
"maxLength": 100,
"minLength": 1,
"title": "Name",
"type": "string"
},
"napalm_args": {
"description": "Additional arguments to pass when initiating the NAPALM driver (JSON format)",
"nullable": true,
"title": "NAPALM arguments",
"type": "string"
},
"napalm_driver": {
"description": "The name of the NAPALM driver to use when interacting with devices",
"maxLength": 50,
"title": "NAPALM driver",
"type": "string"
},
"slug": {
"format": "slug",
"maxLength": 100,
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"title": "Slug",
"type": "string"
},
"virtualmachine_count": {
"readOnly": true,
"title": "Virtualmachine count",
"type": "integer"
}
},
"required": [
"name",
"slug"
],
"type": "object"
},
"PowerFeed": {
"properties": {
"amperage": {
"maximum": 32767,
"minimum": 1,
"title": "Amperage",
"type": "integer"
},
"comments": {
"title": "Comments",
"type": "string"
},
"created": {
"format": "date",
"readOnly": true,
"title": "Created",
"type": "string"
},
"custom_fields": {
"default": {},
"title": "Custom fields",
"type": "object"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"last_updated": {
"format": "date-time",
"readOnly": true,
"title": "Last updated",
"type": "string"
},
"max_utilization": {
"description": "Maximum permissible draw (percentage)",
"maximum": 100,
"minimum": 1,
"title": "Max utilization",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"phase": {
"default": {
"id": 1,
"label": "Single phase",
"value": "single-phase"
},
"properties": {
"label": {
"enum": [
"Single phase",
"Three-phase"
],
"type": "string"
},
"value": {
"enum": [
"single-phase",
"three-phase"
],
"type": "string"
}
},
"required": [
"label",
"value"
],
"title": "Phase",
"type": "object"
},
"power_panel": {
"$ref": "#/components/schemas/NestedPowerPanel"
},
"rack": {
"$ref": "#/components/schemas/NestedRack"
},
"status": {
"default": {
"id": 1,
"label": "Active",
"value": "active"
},
"properties": {
"label": {
"enum": [
"Offline",
"Active",
"Planned",
"Failed"
],
"type": "string"
},
"value": {
"enum": [
"offline",
"active",
"planned",
"failed"
],
"type": "string"
}
},
"required": [
"label",
"value"
],
"title": "Status",
"type": "object"
},
"supply": {
"default": {
"id": 1,
"label": "AC",
"value": "ac"
},
"properties": {
"label": {
"enum": [
"AC",
"DC"
],
"type": "string"
},
"value": {
"enum": [
"ac",
"dc"
],
"type": "string"
}
},
"required": [
"label",
"value"
],
"title": "Supply",
"type": "object"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
},
"type": {
"default": {
"id": 1,
"label": "Primary",
"value": "primary"
},
"properties": {
"label": {
"enum": [
"Primary",
"Redundant"
],
"type": "string"
},
"value": {
"enum": [
"primary",
"redundant"
],
"type": "string"
}
},
"required": [
"label",
"value"
],
"title": "Type",
"type": "object"
},
"voltage": {
"maximum": 32767,
"minimum": -32768,
"title": "Voltage",
"type": "integer"
}
},
"required": [
"power_panel",
"name"
],
"type": "object"
},
"PowerOutlet": {
"properties": {
"cable": {
"$ref": "#/components/schemas/NestedCable"
},
"connected_endpoint": {
"additionalProperties": {
"type": "string"
},
"description": "\nReturn the appropriate serializer for the type of connected object.\n",
"readOnly": true,
"title": "Connected endpoint",
"type": "object"
},
"connected_endpoint_type": {
"readOnly": true,
"title": "Connected endpoint type",
"type": "string"
},
"connection_status": {
"properties": {
"label": {
"enum": [
"Not Connected",
"Connected"
],
"type": "string"
},
"value": {
"enum": [
false,
true
],
"nullable": true,
"type": "boolean"
}
},
"readOnly": true,
"required": [
"label",
"value"
],
"title": "Connection status",
"type": "object"
},
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"device": {
"$ref": "#/components/schemas/NestedDevice"
},
"feed_leg": {
"properties": {
"label": {
"enum": [
"A",
"B",
"C"
],
"type": "string"
},
"value": {
"enum": [
"A",
"B",
"C"
],
"type": "string"
}
},
"required": [
"label",
"value"
],
"title": "Feed leg",
"type": "object"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"power_port": {
"$ref": "#/components/schemas/NestedPowerPort"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
},
"type": {
"properties": {
"label": {
"enum": [
"C5",
"C7",
"C13",
"C15",
"C19",
"P+N+E 4H",
"P+N+E 6H",
"P+N+E 9H",
"2P+E 4H",
"2P+E 6H",
"2P+E 9H",
"3P+E 4H",
"3P+E 6H",
"3P+E 9H",
"3P+N+E 4H",
"3P+N+E 6H",
"3P+N+E 9H",
"NEMA 1-15R",
"NEMA 5-15R",
"NEMA 5-20R",
"NEMA 5-30R",
"NEMA 5-50R",
"NEMA 6-15R",
"NEMA 6-20R",
"NEMA 6-30R",
"NEMA 6-50R",
"NEMA 10-30R",
"NEMA 10-50R",
"NEMA 14-20R",
"NEMA 14-30R",
"NEMA 14-50R",
"NEMA 14-60R",
"NEMA L1-15R",
"NEMA L5-15R",
"NEMA L5-20R",
"NEMA L5-30R",
"NEMA L5-50R",
"NEMA L6-15R",
"NEMA L6-20R",
"NEMA L6-30R",
"NEMA L6-50R",
"NEMA L10-30R",
"NEMA L14-20R",
"NEMA L14-30R",
"NEMA L14-50R",
"NEMA L14-60R",
"NEMA L21-20R",
"NEMA L21-30R",
"CS6360C",
"CS6364C",
"CS8164C",
"CS8264C",
"CS8364C",
"CS8464C",
"ITA Type E (CEE7/5)",
"ITA Type F (CEE7/3)",
"ITA Type G (BS 1363)",
"ITA Type H",
"ITA Type I",
"ITA Type J",
"ITA Type K",
"ITA Type L (CEI 23-50)",
"ITA Type M (BS 546)",
"ITA Type N",
"ITA Type O",
"HDOT Cx"
],
"type": "string"
},
"value": {
"enum": [
"iec-60320-c5",
"iec-60320-c7",
"iec-60320-c13",
"iec-60320-c15",
"iec-60320-c19",
"iec-60309-p-n-e-4h",
"iec-60309-p-n-e-6h",
"iec-60309-p-n-e-9h",
"iec-60309-2p-e-4h",
"iec-60309-2p-e-6h",
"iec-60309-2p-e-9h",
"iec-60309-3p-e-4h",
"iec-60309-3p-e-6h",
"iec-60309-3p-e-9h",
"iec-60309-3p-n-e-4h",
"iec-60309-3p-n-e-6h",
"iec-60309-3p-n-e-9h",
"nema-1-15r",
"nema-5-15r",
"nema-5-20r",
"nema-5-30r",
"nema-5-50r",
"nema-6-15r",
"nema-6-20r",
"nema-6-30r",
"nema-6-50r",
"nema-10-30r",
"nema-10-50r",
"nema-14-20r",
"nema-14-30r",
"nema-14-50r",
"nema-14-60r",
"nema-l1-15r",
"nema-l5-15r",
"nema-l5-20r",
"nema-l5-30r",
"nema-l5-50r",
"nema-l6-15r",
"nema-l6-20r",
"nema-l6-30r",
"nema-l6-50r",
"nema-l10-30r",
"nema-l14-20r",
"nema-l14-30r",
"nema-l14-50r",
"nema-l14-60r",
"nema-l21-20r",
"nema-l21-30r",
"CS6360C",
"CS6364C",
"CS8164C",
"CS8264C",
"CS8364C",
"CS8464C",
"ita-e",
"ita-f",
"ita-g",
"ita-h",
"ita-i",
"ita-j",
"ita-k",
"ita-l",
"ita-m",
"ita-n",
"ita-o",
"hdot-cx"
],
"type": "string"
}
},
"required": [
"label",
"value"
],
"title": "Type",
"type": "object"
}
},
"required": [
"device",
"name"
],
"type": "object"
},
"PowerOutletTemplate": {
"properties": {
"device_type": {
"$ref": "#/components/schemas/NestedDeviceType"
},
"feed_leg": {
"properties": {
"label": {
"enum": [
"A",
"B",
"C"
],
"type": "string"
},
"value": {
"enum": [
"A",
"B",
"C"
],
"type": "string"
}
},
"required": [
"label",
"value"
],
"title": "Feed leg",
"type": "object"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"power_port": {
"$ref": "#/components/schemas/NestedPowerPortTemplate"
},
"type": {
"properties": {
"label": {
"enum": [
"C5",
"C7",
"C13",
"C15",
"C19",
"P+N+E 4H",
"P+N+E 6H",
"P+N+E 9H",
"2P+E 4H",
"2P+E 6H",
"2P+E 9H",
"3P+E 4H",
"3P+E 6H",
"3P+E 9H",
"3P+N+E 4H",
"3P+N+E 6H",
"3P+N+E 9H",
"NEMA 1-15R",
"NEMA 5-15R",
"NEMA 5-20R",
"NEMA 5-30R",
"NEMA 5-50R",
"NEMA 6-15R",
"NEMA 6-20R",
"NEMA 6-30R",
"NEMA 6-50R",
"NEMA 10-30R",
"NEMA 10-50R",
"NEMA 14-20R",
"NEMA 14-30R",
"NEMA 14-50R",
"NEMA 14-60R",
"NEMA L1-15R",
"NEMA L5-15R",
"NEMA L5-20R",
"NEMA L5-30R",
"NEMA L5-50R",
"NEMA L6-15R",
"NEMA L6-20R",
"NEMA L6-30R",
"NEMA L6-50R",
"NEMA L10-30R",
"NEMA L14-20R",
"NEMA L14-30R",
"NEMA L14-50R",
"NEMA L14-60R",
"NEMA L21-20R",
"NEMA L21-30R",
"CS6360C",
"CS6364C",
"CS8164C",
"CS8264C",
"CS8364C",
"CS8464C",
"ITA Type E (CEE7/5)",
"ITA Type F (CEE7/3)",
"ITA Type G (BS 1363)",
"ITA Type H",
"ITA Type I",
"ITA Type J",
"ITA Type K",
"ITA Type L (CEI 23-50)",
"ITA Type M (BS 546)",
"ITA Type N",
"ITA Type O",
"HDOT Cx"
],
"type": "string"
},
"value": {
"enum": [
"iec-60320-c5",
"iec-60320-c7",
"iec-60320-c13",
"iec-60320-c15",
"iec-60320-c19",
"iec-60309-p-n-e-4h",
"iec-60309-p-n-e-6h",
"iec-60309-p-n-e-9h",
"iec-60309-2p-e-4h",
"iec-60309-2p-e-6h",
"iec-60309-2p-e-9h",
"iec-60309-3p-e-4h",
"iec-60309-3p-e-6h",
"iec-60309-3p-e-9h",
"iec-60309-3p-n-e-4h",
"iec-60309-3p-n-e-6h",
"iec-60309-3p-n-e-9h",
"nema-1-15r",
"nema-5-15r",
"nema-5-20r",
"nema-5-30r",
"nema-5-50r",
"nema-6-15r",
"nema-6-20r",
"nema-6-30r",
"nema-6-50r",
"nema-10-30r",
"nema-10-50r",
"nema-14-20r",
"nema-14-30r",
"nema-14-50r",
"nema-14-60r",
"nema-l1-15r",
"nema-l5-15r",
"nema-l5-20r",
"nema-l5-30r",
"nema-l5-50r",
"nema-l6-15r",
"nema-l6-20r",
"nema-l6-30r",
"nema-l6-50r",
"nema-l10-30r",
"nema-l14-20r",
"nema-l14-30r",
"nema-l14-50r",
"nema-l14-60r",
"nema-l21-20r",
"nema-l21-30r",
"CS6360C",
"CS6364C",
"CS8164C",
"CS8264C",
"CS8364C",
"CS8464C",
"ita-e",
"ita-f",
"ita-g",
"ita-h",
"ita-i",
"ita-j",
"ita-k",
"ita-l",
"ita-m",
"ita-n",
"ita-o",
"hdot-cx"
],
"type": "string"
}
},
"required": [
"label",
"value"
],
"title": "Type",
"type": "object"
}
},
"required": [
"device_type",
"name"
],
"type": "object"
},
"PowerPanel": {
"properties": {
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"powerfeed_count": {
"readOnly": true,
"title": "Powerfeed count",
"type": "integer"
},
"rack_group": {
"$ref": "#/components/schemas/NestedRackGroup"
},
"site": {
"$ref": "#/components/schemas/NestedSite"
}
},
"required": [
"site",
"name"
],
"type": "object"
},
"PowerPort": {
"properties": {
"allocated_draw": {
"description": "Allocated power draw (watts)",
"maximum": 32767,
"minimum": 1,
"nullable": true,
"title": "Allocated draw",
"type": "integer"
},
"cable": {
"$ref": "#/components/schemas/NestedCable"
},
"connected_endpoint": {
"additionalProperties": {
"type": "string"
},
"description": "\nReturn the appropriate serializer for the type of connected object.\n",
"readOnly": true,
"title": "Connected endpoint",
"type": "object"
},
"connected_endpoint_type": {
"readOnly": true,
"title": "Connected endpoint type",
"type": "string"
},
"connection_status": {
"properties": {
"label": {
"enum": [
"Not Connected",
"Connected"
],
"type": "string"
},
"value": {
"enum": [
false,
true
],
"nullable": true,
"type": "boolean"
}
},
"readOnly": true,
"required": [
"label",
"value"
],
"title": "Connection status",
"type": "object"
},
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"device": {
"$ref": "#/components/schemas/NestedDevice"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"maximum_draw": {
"description": "Maximum power draw (watts)",
"maximum": 32767,
"minimum": 1,
"nullable": true,
"title": "Maximum draw",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
},
"type": {
"properties": {
"label": {
"enum": [
"C6",
"C8",
"C14",
"C16",
"C20",
"P+N+E 4H",
"P+N+E 6H",
"P+N+E 9H",
"2P+E 4H",
"2P+E 6H",
"2P+E 9H",
"3P+E 4H",
"3P+E 6H",
"3P+E 9H",
"3P+N+E 4H",
"3P+N+E 6H",
"3P+N+E 9H",
"NEMA 1-15P",
"NEMA 5-15P",
"NEMA 5-20P",
"NEMA 5-30P",
"NEMA 5-50P",
"NEMA 6-15P",
"NEMA 6-20P",
"NEMA 6-30P",
"NEMA 6-50P",
"NEMA 10-30P",
"NEMA 10-50P",
"NEMA 14-20P",
"NEMA 14-30P",
"NEMA 14-50P",
"NEMA 14-60P",
"NEMA L1-15P",
"NEMA L5-15P",
"NEMA L5-20P",
"NEMA L5-30P",
"NEMA L5-50P",
"NEMA L6-15P",
"NEMA L6-20P",
"NEMA L6-30P",
"NEMA L6-50P",
"NEMA L10-30P",
"NEMA L14-20P",
"NEMA L14-30P",
"NEMA L14-50P",
"NEMA L14-60P",
"NEMA L21-20P",
"NEMA L21-30P",
"CS6361C",
"CS6365C",
"CS8165C",
"CS8265C",
"CS8365C",
"CS8465C",
"ITA Type E (CEE 7/5)",
"ITA Type F (CEE 7/4)",
"ITA Type E/F (CEE 7/7)",
"ITA Type G (BS 1363)",
"ITA Type H",
"ITA Type I",
"ITA Type J",
"ITA Type K",
"ITA Type L (CEI 23-50)",
"ITA Type M (BS 546)",
"ITA Type N",
"ITA Type O"
],
"type": "string"
},
"value": {
"enum": [
"iec-60320-c6",
"iec-60320-c8",
"iec-60320-c14",
"iec-60320-c16",
"iec-60320-c20",
"iec-60309-p-n-e-4h",
"iec-60309-p-n-e-6h",
"iec-60309-p-n-e-9h",
"iec-60309-2p-e-4h",
"iec-60309-2p-e-6h",
"iec-60309-2p-e-9h",
"iec-60309-3p-e-4h",
"iec-60309-3p-e-6h",
"iec-60309-3p-e-9h",
"iec-60309-3p-n-e-4h",
"iec-60309-3p-n-e-6h",
"iec-60309-3p-n-e-9h",
"nema-1-15p",
"nema-5-15p",
"nema-5-20p",
"nema-5-30p",
"nema-5-50p",
"nema-6-15p",
"nema-6-20p",
"nema-6-30p",
"nema-6-50p",
"nema-10-30p",
"nema-10-50p",
"nema-14-20p",
"nema-14-30p",
"nema-14-50p",
"nema-14-60p",
"nema-l1-15p",
"nema-l5-15p",
"nema-l5-20p",
"nema-l5-30p",
"nema-l5-50p",
"nema-l6-15p",
"nema-l6-20p",
"nema-l6-30p",
"nema-l6-50p",
"nema-l10-30p",
"nema-l14-20p",
"nema-l14-30p",
"nema-l14-50p",
"nema-l14-60p",
"nema-l21-20p",
"nema-l21-30p",
"cs6361c",
"cs6365c",
"cs8165c",
"cs8265c",
"cs8365c",
"cs8465c",
"ita-e",
"ita-f",
"ita-ef",
"ita-g",
"ita-h",
"ita-i",
"ita-j",
"ita-k",
"ita-l",
"ita-m",
"ita-n",
"ita-o"
],
"type": "string"
}
},
"required": [
"label",
"value"
],
"title": "Type",
"type": "object"
}
},
"required": [
"device",
"name"
],
"type": "object"
},
"PowerPortTemplate": {
"properties": {
"allocated_draw": {
"description": "Allocated power draw (watts)",
"maximum": 32767,
"minimum": 1,
"nullable": true,
"title": "Allocated draw",
"type": "integer"
},
"device_type": {
"$ref": "#/components/schemas/NestedDeviceType"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"maximum_draw": {
"description": "Maximum power draw (watts)",
"maximum": 32767,
"minimum": 1,
"nullable": true,
"title": "Maximum draw",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"type": {
"properties": {
"label": {
"enum": [
"C6",
"C8",
"C14",
"C16",
"C20",
"P+N+E 4H",
"P+N+E 6H",
"P+N+E 9H",
"2P+E 4H",
"2P+E 6H",
"2P+E 9H",
"3P+E 4H",
"3P+E 6H",
"3P+E 9H",
"3P+N+E 4H",
"3P+N+E 6H",
"3P+N+E 9H",
"NEMA 1-15P",
"NEMA 5-15P",
"NEMA 5-20P",
"NEMA 5-30P",
"NEMA 5-50P",
"NEMA 6-15P",
"NEMA 6-20P",
"NEMA 6-30P",
"NEMA 6-50P",
"NEMA 10-30P",
"NEMA 10-50P",
"NEMA 14-20P",
"NEMA 14-30P",
"NEMA 14-50P",
"NEMA 14-60P",
"NEMA L1-15P",
"NEMA L5-15P",
"NEMA L5-20P",
"NEMA L5-30P",
"NEMA L5-50P",
"NEMA L6-15P",
"NEMA L6-20P",
"NEMA L6-30P",
"NEMA L6-50P",
"NEMA L10-30P",
"NEMA L14-20P",
"NEMA L14-30P",
"NEMA L14-50P",
"NEMA L14-60P",
"NEMA L21-20P",
"NEMA L21-30P",
"CS6361C",
"CS6365C",
"CS8165C",
"CS8265C",
"CS8365C",
"CS8465C",
"ITA Type E (CEE 7/5)",
"ITA Type F (CEE 7/4)",
"ITA Type E/F (CEE 7/7)",
"ITA Type G (BS 1363)",
"ITA Type H",
"ITA Type I",
"ITA Type J",
"ITA Type K",
"ITA Type L (CEI 23-50)",
"ITA Type M (BS 546)",
"ITA Type N",
"ITA Type O"
],
"type": "string"
},
"value": {
"enum": [
"iec-60320-c6",
"iec-60320-c8",
"iec-60320-c14",
"iec-60320-c16",
"iec-60320-c20",
"iec-60309-p-n-e-4h",
"iec-60309-p-n-e-6h",
"iec-60309-p-n-e-9h",
"iec-60309-2p-e-4h",
"iec-60309-2p-e-6h",
"iec-60309-2p-e-9h",
"iec-60309-3p-e-4h",
"iec-60309-3p-e-6h",
"iec-60309-3p-e-9h",
"iec-60309-3p-n-e-4h",
"iec-60309-3p-n-e-6h",
"iec-60309-3p-n-e-9h",
"nema-1-15p",
"nema-5-15p",
"nema-5-20p",
"nema-5-30p",
"nema-5-50p",
"nema-6-15p",
"nema-6-20p",
"nema-6-30p",
"nema-6-50p",
"nema-10-30p",
"nema-10-50p",
"nema-14-20p",
"nema-14-30p",
"nema-14-50p",
"nema-14-60p",
"nema-l1-15p",
"nema-l5-15p",
"nema-l5-20p",
"nema-l5-30p",
"nema-l5-50p",
"nema-l6-15p",
"nema-l6-20p",
"nema-l6-30p",
"nema-l6-50p",
"nema-l10-30p",
"nema-l14-20p",
"nema-l14-30p",
"nema-l14-50p",
"nema-l14-60p",
"nema-l21-20p",
"nema-l21-30p",
"cs6361c",
"cs6365c",
"cs8165c",
"cs8265c",
"cs8365c",
"cs8465c",
"ita-e",
"ita-f",
"ita-ef",
"ita-g",
"ita-h",
"ita-i",
"ita-j",
"ita-k",
"ita-l",
"ita-m",
"ita-n",
"ita-o"
],
"type": "string"
}
},
"required": [
"label",
"value"
],
"title": "Type",
"type": "object"
}
},
"required": [
"device_type",
"name"
],
"type": "object"
},
"Prefix": {
"properties": {
"created": {
"format": "date",
"readOnly": true,
"title": "Created",
"type": "string"
},
"custom_fields": {
"default": {},
"title": "Custom fields",
"type": "object"
},
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"family": {
"properties": {
"label": {
"enum": [
"IPv4",
"IPv6"
],
"type": "string"
},
"value": {
"enum": [
4,
6
],
"type": "integer"
}
},
"readOnly": true,
"required": [
"label",
"value"
],
"title": "Family",
"type": "object"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"is_pool": {
"description": "All IP addresses within this prefix are considered usable",
"title": "Is a pool",
"type": "boolean"
},
"last_updated": {
"format": "date-time",
"readOnly": true,
"title": "Last updated",
"type": "string"
},
"prefix": {
"description": "IPv4 or IPv6 network with mask",
"title": "Prefix",
"type": "string"
},
"role": {
"$ref": "#/components/schemas/NestedRole"
},
"site": {
"$ref": "#/components/schemas/NestedSite"
},
"status": {
"properties": {
"label": {
"enum": [
"Container",
"Active",
"Reserved",
"Deprecated"
],
"type": "string"
},
"value": {
"enum": [
"container",
"active",
"reserved",
"deprecated"
],
"type": "string"
}
},
"required": [
"label",
"value"
],
"title": "Status",
"type": "object"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
},
"tenant": {
"$ref": "#/components/schemas/NestedTenant"
},
"vlan": {
"$ref": "#/components/schemas/NestedVLAN"
},
"vrf": {
"$ref": "#/components/schemas/NestedVRF"
}
},
"required": [
"prefix"
],
"type": "object"
},
"Provider": {
"properties": {
"account": {
"maxLength": 30,
"title": "Account number",
"type": "string"
},
"admin_contact": {
"title": "Admin contact",
"type": "string"
},
"asn": {
"description": "32-bit autonomous system number",
"maximum": 4294967295,
"minimum": 1,
"nullable": true,
"title": "ASN",
"type": "integer"
},
"circuit_count": {
"readOnly": true,
"title": "Circuit count",
"type": "integer"
},
"comments": {
"title": "Comments",
"type": "string"
},
"created": {
"format": "date",
"readOnly": true,
"title": "Created",
"type": "string"
},
"custom_fields": {
"default": {},
"title": "Custom fields",
"type": "object"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"last_updated": {
"format": "date-time",
"readOnly": true,
"title": "Last updated",
"type": "string"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"noc_contact": {
"title": "NOC contact",
"type": "string"
},
"portal_url": {
"format": "uri",
"maxLength": 200,
"title": "Portal URL",
"type": "string"
},
"slug": {
"format": "slug",
"maxLength": 50,
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"title": "Slug",
"type": "string"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
}
},
"required": [
"name",
"slug"
],
"type": "object"
},
"RIR": {
"properties": {
"aggregate_count": {
"readOnly": true,
"title": "Aggregate count",
"type": "integer"
},
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"is_private": {
"description": "IP space managed by this RIR is considered private",
"title": "Private",
"type": "boolean"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"slug": {
"format": "slug",
"maxLength": 50,
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"title": "Slug",
"type": "string"
}
},
"required": [
"name",
"slug"
],
"type": "object"
},
"Rack": {
"properties": {
"asset_tag": {
"description": "A unique tag used to identify this rack",
"maxLength": 50,
"nullable": true,
"title": "Asset tag",
"type": "string"
},
"comments": {
"title": "Comments",
"type": "string"
},
"created": {
"format": "date",
"readOnly": true,
"title": "Created",
"type": "string"
},
"custom_fields": {
"default": {},
"title": "Custom fields",
"type": "object"
},
"desc_units": {
"description": "Units are numbered top-to-bottom",
"title": "Descending units",
"type": "boolean"
},
"device_count": {
"readOnly": true,
"title": "Device count",
"type": "integer"
},
"display_name": {
"readOnly": true,
"title": "Display name",
"type": "string"
},
"facility_id": {
"description": "Locally-assigned identifier",
"maxLength": 50,
"nullable": true,
"title": "Facility ID",
"type": "string"
},
"group": {
"$ref": "#/components/schemas/NestedRackGroup"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"last_updated": {
"format": "date-time",
"readOnly": true,
"title": "Last updated",
"type": "string"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"outer_depth": {
"description": "Outer dimension of rack (depth)",
"maximum": 32767,
"minimum": 0,
"nullable": true,
"title": "Outer depth",
"type": "integer"
},
"outer_unit": {
"properties": {
"label": {
"enum": [
"Millimeters",
"Inches"
],
"type": "string"
},
"value": {
"enum": [
"mm",
"in"
],
"type": "string"
}
},
"required": [
"label",
"value"
],
"title": "Outer unit",
"type": "object"
},
"outer_width": {
"description": "Outer dimension of rack (width)",
"maximum": 32767,
"minimum": 0,
"nullable": true,
"title": "Outer width",
"type": "integer"
},
"powerfeed_count": {
"readOnly": true,
"title": "Powerfeed count",
"type": "integer"
},
"role": {
"$ref": "#/components/schemas/NestedRackRole"
},
"serial": {
"maxLength": 50,
"title": "Serial number",
"type": "string"
},
"site": {
"$ref": "#/components/schemas/NestedSite"
},
"status": {
"properties": {
"label": {
"enum": [
"Reserved",
"Available",
"Planned",
"Active",
"Deprecated"
],
"type": "string"
},
"value": {
"enum": [
"reserved",
"available",
"planned",
"active",
"deprecated"
],
"type": "string"
}
},
"required": [
"label",
"value"
],
"title": "Status",
"type": "object"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
},
"tenant": {
"$ref": "#/components/schemas/NestedTenant"
},
"type": {
"properties": {
"label": {
"enum": [
"2-post frame",
"4-post frame",
"4-post cabinet",
"Wall-mounted frame",
"Wall-mounted cabinet"
],
"type": "string"
},
"value": {
"enum": [
"2-post-frame",
"4-post-frame",
"4-post-cabinet",
"wall-frame",
"wall-cabinet"
],
"type": "string"
}
},
"required": [
"label",
"value"
],
"title": "Type",
"type": "object"
},
"u_height": {
"description": "Height in rack units",
"maximum": 100,
"minimum": 1,
"title": "Height (U)",
"type": "integer"
},
"width": {
"properties": {
"label": {
"enum": [
"10 inches",
"19 inches",
"21 inches",
"23 inches"
],
"type": "string"
},
"value": {
"enum": [
10,
19,
21,
23
],
"type": "integer"
}
},
"required": [
"label",
"value"
],
"title": "Width",
"type": "object"
}
},
"required": [
"name",
"site"
],
"type": "object"
},
"RackGroup": {
"properties": {
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"parent": {
"$ref": "#/components/schemas/NestedRackGroup"
},
"rack_count": {
"readOnly": true,
"title": "Rack count",
"type": "integer"
},
"site": {
"$ref": "#/components/schemas/NestedSite"
},
"slug": {
"format": "slug",
"maxLength": 50,
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"title": "Slug",
"type": "string"
}
},
"required": [
"name",
"slug",
"site"
],
"type": "object"
},
"RackReservation": {
"properties": {
"created": {
"format": "date",
"readOnly": true,
"title": "Created",
"type": "string"
},
"description": {
"maxLength": 200,
"minLength": 1,
"title": "Description",
"type": "string"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"rack": {
"$ref": "#/components/schemas/NestedRack"
},
"tenant": {
"$ref": "#/components/schemas/NestedTenant"
},
"units": {
"items": {
"maximum": 32767,
"minimum": 0,
"title": "Units",
"type": "integer"
},
"type": "array"
},
"user": {
"$ref": "#/components/schemas/NestedUser"
}
},
"required": [
"rack",
"units",
"user",
"description"
],
"type": "object"
},
"RackRole": {
"properties": {
"color": {
"maxLength": 6,
"minLength": 1,
"pattern": "^[0-9a-f]{6}$",
"title": "Color",
"type": "string"
},
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"rack_count": {
"readOnly": true,
"title": "Rack count",
"type": "integer"
},
"slug": {
"format": "slug",
"maxLength": 50,
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"title": "Slug",
"type": "string"
}
},
"required": [
"name",
"slug"
],
"type": "object"
},
"RackUnit": {
"properties": {
"device": {
"$ref": "#/components/schemas/NestedDevice"
},
"face": {
"properties": {
"label": {
"enum": [
"Front",
"Rear"
],
"type": "string"
},
"value": {
"enum": [
"front",
"rear"
],
"type": "string"
}
},
"readOnly": true,
"required": [
"label",
"value"
],
"title": "Face",
"type": "object"
},
"id": {
"readOnly": true,
"title": "Id",
"type": "integer"
},
"name": {
"minLength": 1,
"readOnly": true,
"title": "Name",
"type": "string"
}
},
"type": "object"
},
"RearPort": {
"properties": {
"cable": {
"$ref": "#/components/schemas/NestedCable"
},
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"device": {
"$ref": "#/components/schemas/NestedDevice"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 64,
"minLength": 1,
"title": "Name",
"type": "string"
},
"positions": {
"maximum": 64,
"minimum": 1,
"title": "Positions",
"type": "integer"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
},
"type": {
"properties": {
"label": {
"enum": [
"8P8C",
"110 Punch",
"BNC",
"MRJ21",
"FC",
"LC",
"LC/APC",
"LSH",
"LSH/APC",
"MPO",
"MTRJ",
"SC",
"SC/APC",
"ST"
],
"type": "string"
},
"value": {
"enum": [
"8p8c",
"110-punch",
"bnc",
"mrj21",
"fc",
"lc",
"lc-apc",
"lsh",
"lsh-apc",
"mpo",
"mtrj",
"sc",
"sc-apc",
"st"
],
"type": "string"
}
},
"required": [
"label",
"value"
],
"title": "Type",
"type": "object"
}
},
"required": [
"device",
"name",
"type"
],
"type": "object"
},
"RearPortTemplate": {
"properties": {
"device_type": {
"$ref": "#/components/schemas/NestedDeviceType"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 64,
"minLength": 1,
"title": "Name",
"type": "string"
},
"positions": {
"maximum": 64,
"minimum": 1,
"title": "Positions",
"type": "integer"
},
"type": {
"properties": {
"label": {
"enum": [
"8P8C",
"110 Punch",
"BNC",
"MRJ21",
"FC",
"LC",
"LC/APC",
"LSH",
"LSH/APC",
"MPO",
"MTRJ",
"SC",
"SC/APC",
"ST"
],
"type": "string"
},
"value": {
"enum": [
"8p8c",
"110-punch",
"bnc",
"mrj21",
"fc",
"lc",
"lc-apc",
"lsh",
"lsh-apc",
"mpo",
"mtrj",
"sc",
"sc-apc",
"st"
],
"type": "string"
}
},
"required": [
"label",
"value"
],
"title": "Type",
"type": "object"
}
},
"required": [
"device_type",
"name",
"type"
],
"type": "object"
},
"Region": {
"properties": {
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"parent": {
"$ref": "#/components/schemas/NestedRegion"
},
"site_count": {
"readOnly": true,
"title": "Site count",
"type": "integer"
},
"slug": {
"format": "slug",
"maxLength": 50,
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"title": "Slug",
"type": "string"
}
},
"required": [
"name",
"slug"
],
"type": "object"
},
"Role": {
"properties": {
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"prefix_count": {
"readOnly": true,
"title": "Prefix count",
"type": "integer"
},
"slug": {
"format": "slug",
"maxLength": 50,
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"title": "Slug",
"type": "string"
},
"vlan_count": {
"readOnly": true,
"title": "Vlan count",
"type": "integer"
},
"weight": {
"maximum": 32767,
"minimum": 0,
"title": "Weight",
"type": "integer"
}
},
"required": [
"name",
"slug"
],
"type": "object"
},
"Secret": {
"properties": {
"created": {
"format": "date",
"readOnly": true,
"title": "Created",
"type": "string"
},
"custom_fields": {
"default": {},
"title": "Custom fields",
"type": "object"
},
"device": {
"$ref": "#/components/schemas/NestedDevice"
},
"hash": {
"minLength": 1,
"readOnly": true,
"title": "Hash",
"type": "string"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"last_updated": {
"format": "date-time",
"readOnly": true,
"title": "Last updated",
"type": "string"
},
"name": {
"maxLength": 100,
"title": "Name",
"type": "string"
},
"plaintext": {
"minLength": 1,
"title": "Plaintext",
"type": "string"
},
"role": {
"$ref": "#/components/schemas/NestedSecretRole"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
}
},
"required": [
"device",
"role",
"plaintext"
],
"type": "object"
},
"SecretRole": {
"properties": {
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"secret_count": {
"readOnly": true,
"title": "Secret count",
"type": "integer"
},
"slug": {
"format": "slug",
"maxLength": 50,
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"title": "Slug",
"type": "string"
}
},
"required": [
"name",
"slug"
],
"type": "object"
},
"Service": {
"properties": {
"created": {
"format": "date",
"readOnly": true,
"title": "Created",
"type": "string"
},
"custom_fields": {
"default": {},
"title": "Custom fields",
"type": "object"
},
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"device": {
"$ref": "#/components/schemas/NestedDevice"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"ipaddresses": {
"items": {
"$ref": "#/components/schemas/NestedIPAddress"
},
"type": "array",
"uniqueItems": true
},
"last_updated": {
"format": "date-time",
"readOnly": true,
"title": "Last updated",
"type": "string"
},
"name": {
"maxLength": 30,
"minLength": 1,
"title": "Name",
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"title": "Port number",
"type": "integer"
},
"protocol": {
"properties": {
"label": {
"enum": [
"TCP",
"UDP"
],
"type": "string"
},
"value": {
"enum": [
"tcp",
"udp"
],
"type": "string"
}
},
"required": [
"label",
"value"
],
"title": "Protocol",
"type": "object"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
},
"virtual_machine": {
"$ref": "#/components/schemas/NestedVirtualMachine"
}
},
"required": [
"name",
"port"
],
"type": "object"
},
"Site": {
"properties": {
"asn": {
"description": "32-bit autonomous system number",
"maximum": 4294967295,
"minimum": 1,
"nullable": true,
"title": "ASN",
"type": "integer"
},
"circuit_count": {
"readOnly": true,
"title": "Circuit count",
"type": "integer"
},
"comments": {
"title": "Comments",
"type": "string"
},
"contact_email": {
"format": "email",
"maxLength": 254,
"title": "Contact E-mail",
"type": "string"
},
"contact_name": {
"maxLength": 50,
"title": "Contact name",
"type": "string"
},
"contact_phone": {
"maxLength": 20,
"title": "Contact phone",
"type": "string"
},
"created": {
"format": "date",
"readOnly": true,
"title": "Created",
"type": "string"
},
"custom_fields": {
"default": {},
"title": "Custom fields",
"type": "object"
},
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"device_count": {
"readOnly": true,
"title": "Device count",
"type": "integer"
},
"facility": {
"description": "Local facility ID or description",
"maxLength": 50,
"title": "Facility",
"type": "string"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"last_updated": {
"format": "date-time",
"readOnly": true,
"title": "Last updated",
"type": "string"
},
"latitude": {
"description": "GPS coordinate (latitude)",
"format": "decimal",
"nullable": true,
"title": "Latitude",
"type": "string"
},
"longitude": {
"description": "GPS coordinate (longitude)",
"format": "decimal",
"nullable": true,
"title": "Longitude",
"type": "string"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"physical_address": {
"maxLength": 200,
"title": "Physical address",
"type": "string"
},
"prefix_count": {
"readOnly": true,
"title": "Prefix count",
"type": "integer"
},
"rack_count": {
"readOnly": true,
"title": "Rack count",
"type": "integer"
},
"region": {
"$ref": "#/components/schemas/NestedRegion"
},
"shipping_address": {
"maxLength": 200,
"title": "Shipping address",
"type": "string"
},
"slug": {
"format": "slug",
"maxLength": 50,
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"title": "Slug",
"type": "string"
},
"status": {
"properties": {
"label": {
"enum": [
"Active",
"Planned",
"Retired"
],
"type": "string"
},
"value": {
"enum": [
"active",
"planned",
"retired"
],
"type": "string"
}
},
"required": [
"label",
"value"
],
"title": "Status",
"type": "object"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
},
"tenant": {
"$ref": "#/components/schemas/NestedTenant"
},
"time_zone": {
"title": "Time zone",
"type": "string"
},
"virtualmachine_count": {
"readOnly": true,
"title": "Virtualmachine count",
"type": "integer"
},
"vlan_count": {
"readOnly": true,
"title": "Vlan count",
"type": "integer"
}
},
"required": [
"name",
"slug"
],
"type": "object"
},
"Tag": {
"properties": {
"color": {
"maxLength": 6,
"minLength": 1,
"pattern": "^[0-9a-f]{6}$",
"title": "Color",
"type": "string"
},
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 100,
"minLength": 1,
"title": "Name",
"type": "string"
},
"slug": {
"format": "slug",
"maxLength": 100,
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"title": "Slug",
"type": "string"
},
"tagged_items": {
"readOnly": true,
"title": "Tagged items",
"type": "integer"
}
},
"required": [
"name",
"slug"
],
"type": "object"
},
"Tenant": {
"properties": {
"circuit_count": {
"readOnly": true,
"title": "Circuit count",
"type": "integer"
},
"cluster_count": {
"readOnly": true,
"title": "Cluster count",
"type": "integer"
},
"comments": {
"title": "Comments",
"type": "string"
},
"created": {
"format": "date",
"readOnly": true,
"title": "Created",
"type": "string"
},
"custom_fields": {
"default": {},
"title": "Custom fields",
"type": "object"
},
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"device_count": {
"readOnly": true,
"title": "Device count",
"type": "integer"
},
"group": {
"$ref": "#/components/schemas/NestedTenantGroup"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"ipaddress_count": {
"readOnly": true,
"title": "Ipaddress count",
"type": "integer"
},
"last_updated": {
"format": "date-time",
"readOnly": true,
"title": "Last updated",
"type": "string"
},
"name": {
"maxLength": 30,
"minLength": 1,
"title": "Name",
"type": "string"
},
"prefix_count": {
"readOnly": true,
"title": "Prefix count",
"type": "integer"
},
"rack_count": {
"readOnly": true,
"title": "Rack count",
"type": "integer"
},
"site_count": {
"readOnly": true,
"title": "Site count",
"type": "integer"
},
"slug": {
"format": "slug",
"maxLength": 50,
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"title": "Slug",
"type": "string"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
},
"virtualmachine_count": {
"readOnly": true,
"title": "Virtualmachine count",
"type": "integer"
},
"vlan_count": {
"readOnly": true,
"title": "Vlan count",
"type": "integer"
},
"vrf_count": {
"readOnly": true,
"title": "Vrf count",
"type": "integer"
}
},
"required": [
"name",
"slug"
],
"type": "object"
},
"TenantGroup": {
"properties": {
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"parent": {
"$ref": "#/components/schemas/NestedTenantGroup"
},
"slug": {
"format": "slug",
"maxLength": 50,
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"title": "Slug",
"type": "string"
},
"tenant_count": {
"readOnly": true,
"title": "Tenant count",
"type": "integer"
}
},
"required": [
"name",
"slug"
],
"type": "object"
},
"VLAN": {
"properties": {
"created": {
"format": "date",
"readOnly": true,
"title": "Created",
"type": "string"
},
"custom_fields": {
"default": {},
"title": "Custom fields",
"type": "object"
},
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"display_name": {
"readOnly": true,
"title": "Display name",
"type": "string"
},
"group": {
"$ref": "#/components/schemas/NestedVLANGroup"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"last_updated": {
"format": "date-time",
"readOnly": true,
"title": "Last updated",
"type": "string"
},
"name": {
"maxLength": 64,
"minLength": 1,
"title": "Name",
"type": "string"
},
"prefix_count": {
"readOnly": true,
"title": "Prefix count",
"type": "integer"
},
"role": {
"$ref": "#/components/schemas/NestedRole"
},
"site": {
"$ref": "#/components/schemas/NestedSite"
},
"status": {
"properties": {
"label": {
"enum": [
"Active",
"Reserved",
"Deprecated"
],
"type": "string"
},
"value": {
"enum": [
"active",
"reserved",
"deprecated"
],
"type": "string"
}
},
"required": [
"label",
"value"
],
"title": "Status",
"type": "object"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
},
"tenant": {
"$ref": "#/components/schemas/NestedTenant"
},
"vid": {
"maximum": 4094,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"required": [
"vid",
"name"
],
"type": "object"
},
"VLANGroup": {
"properties": {
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"site": {
"$ref": "#/components/schemas/NestedSite"
},
"slug": {
"format": "slug",
"maxLength": 50,
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"title": "Slug",
"type": "string"
},
"vlan_count": {
"readOnly": true,
"title": "Vlan count",
"type": "integer"
}
},
"required": [
"name",
"slug"
],
"type": "object"
},
"VRF": {
"properties": {
"created": {
"format": "date",
"readOnly": true,
"title": "Created",
"type": "string"
},
"custom_fields": {
"default": {},
"title": "Custom fields",
"type": "object"
},
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"display_name": {
"readOnly": true,
"title": "Display name",
"type": "string"
},
"enforce_unique": {
"description": "Prevent duplicate prefixes/IP addresses within this VRF",
"title": "Enforce unique space",
"type": "boolean"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"ipaddress_count": {
"readOnly": true,
"title": "Ipaddress count",
"type": "integer"
},
"last_updated": {
"format": "date-time",
"readOnly": true,
"title": "Last updated",
"type": "string"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"prefix_count": {
"readOnly": true,
"title": "Prefix count",
"type": "integer"
},
"rd": {
"description": "Unique route distinguisher (as defined in RFC 4364)",
"maxLength": 21,
"nullable": true,
"title": "Route distinguisher",
"type": "string"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
},
"tenant": {
"$ref": "#/components/schemas/NestedTenant"
}
},
"required": [
"name"
],
"type": "object"
},
"VirtualChassis": {
"properties": {
"domain": {
"maxLength": 30,
"title": "Domain",
"type": "string"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"master": {
"$ref": "#/components/schemas/NestedDevice"
},
"member_count": {
"readOnly": true,
"title": "Member count",
"type": "integer"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
}
},
"required": [
"master"
],
"type": "object"
},
"VirtualMachineInterface": {
"properties": {
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"enabled": {
"title": "Enabled",
"type": "boolean"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"mac_address": {
"nullable": true,
"title": "MAC Address",
"type": "string"
},
"mode": {
"properties": {
"label": {
"enum": [
"Access",
"Tagged",
"Tagged (All)"
],
"type": "string"
},
"value": {
"enum": [
"access",
"tagged",
"tagged-all"
],
"type": "string"
}
},
"required": [
"label",
"value"
],
"title": "Mode",
"type": "object"
},
"mtu": {
"maximum": 65536,
"minimum": 1,
"nullable": true,
"title": "MTU",
"type": "integer"
},
"name": {
"maxLength": 64,
"minLength": 1,
"title": "Name",
"type": "string"
},
"tagged_vlans": {
"items": {
"$ref": "#/components/schemas/NestedVLAN"
},
"type": "array",
"uniqueItems": true
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
},
"type": {
"default": {
"label": "Virtual",
"value": "virtual"
},
"properties": {
"label": {
"enum": [
"Virtual"
],
"type": "string"
},
"value": {
"enum": [
"virtual"
],
"type": "string"
}
},
"required": [
"label",
"value"
],
"title": "Type",
"type": "object"
},
"untagged_vlan": {
"$ref": "#/components/schemas/NestedVLAN"
},
"virtual_machine": {
"$ref": "#/components/schemas/NestedVirtualMachine"
}
},
"required": [
"virtual_machine",
"name"
],
"type": "object"
},
"VirtualMachineWithConfigContext": {
"properties": {
"cluster": {
"$ref": "#/components/schemas/NestedCluster"
},
"comments": {
"title": "Comments",
"type": "string"
},
"config_context": {
"additionalProperties": {
"type": "string"
},
"readOnly": true,
"title": "Config context",
"type": "object"
},
"created": {
"format": "date",
"readOnly": true,
"title": "Created",
"type": "string"
},
"custom_fields": {
"default": {},
"title": "Custom fields",
"type": "object"
},
"disk": {
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"title": "Disk (GB)",
"type": "integer"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"last_updated": {
"format": "date-time",
"readOnly": true,
"title": "Last updated",
"type": "string"
},
"local_context_data": {
"nullable": true,
"title": "Local context data",
"type": "string"
},
"memory": {
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"title": "Memory (MB)",
"type": "integer"
},
"name": {
"maxLength": 64,
"minLength": 1,
"title": "Name",
"type": "string"
},
"platform": {
"$ref": "#/components/schemas/NestedPlatform"
},
"primary_ip": {
"$ref": "#/components/schemas/NestedIPAddress"
},
"primary_ip4": {
"$ref": "#/components/schemas/NestedIPAddress"
},
"primary_ip6": {
"$ref": "#/components/schemas/NestedIPAddress"
},
"role": {
"$ref": "#/components/schemas/NestedDeviceRole"
},
"site": {
"$ref": "#/components/schemas/NestedSite"
},
"status": {
"properties": {
"label": {
"enum": [
"Offline",
"Active",
"Planned",
"Staged",
"Failed",
"Decommissioning"
],
"type": "string"
},
"value": {
"enum": [
"offline",
"active",
"planned",
"staged",
"failed",
"decommissioning"
],
"type": "string"
}
},
"required": [
"label",
"value"
],
"title": "Status",
"type": "object"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
},
"tenant": {
"$ref": "#/components/schemas/NestedTenant"
},
"vcpus": {
"maximum": 32767,
"minimum": 0,
"nullable": true,
"title": "VCPUs",
"type": "integer"
}
},
"required": [
"name",
"cluster"
],
"type": "object"
},
"WritableAggregate": {
"properties": {
"created": {
"format": "date",
"readOnly": true,
"title": "Created",
"type": "string"
},
"custom_fields": {
"default": {},
"title": "Custom fields",
"type": "object"
},
"date_added": {
"format": "date",
"nullable": true,
"title": "Date added",
"type": "string"
},
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"family": {
"readOnly": true,
"title": "Family",
"type": "string"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"last_updated": {
"format": "date-time",
"readOnly": true,
"title": "Last updated",
"type": "string"
},
"prefix": {
"title": "Prefix",
"type": "string"
},
"rir": {
"title": "RIR",
"type": "integer"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
}
},
"required": [
"prefix",
"rir"
],
"type": "object"
},
"WritableAvailableIP": {
"properties": {
"address": {
"minLength": 1,
"readOnly": true,
"title": "Address",
"type": "string"
},
"family": {
"readOnly": true,
"title": "Family",
"type": "integer"
}
},
"type": "object"
},
"WritableCable": {
"properties": {
"color": {
"maxLength": 6,
"pattern": "^[0-9a-f]{6}$",
"title": "Color",
"type": "string"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"label": {
"maxLength": 100,
"title": "Label",
"type": "string"
},
"length": {
"maximum": 32767,
"minimum": 0,
"nullable": true,
"title": "Length",
"type": "integer"
},
"length_unit": {
"enum": [
"m",
"cm",
"ft",
"in"
],
"title": "Length unit",
"type": "string"
},
"status": {
"enum": [
"connected",
"planned",
"decommissioning"
],
"title": "Status",
"type": "string"
},
"termination_a": {
"additionalProperties": {
"type": "string"
},
"readOnly": true,
"title": "Termination a",
"type": "object"
},
"termination_a_id": {
"maximum": 2147483647,
"minimum": 0,
"title": "Termination a id",
"type": "integer"
},
"termination_a_type": {
"title": "Termination a type",
"type": "string"
},
"termination_b": {
"additionalProperties": {
"type": "string"
},
"readOnly": true,
"title": "Termination b",
"type": "object"
},
"termination_b_id": {
"maximum": 2147483647,
"minimum": 0,
"title": "Termination b id",
"type": "integer"
},
"termination_b_type": {
"title": "Termination b type",
"type": "string"
},
"type": {
"enum": [
"cat3",
"cat5",
"cat5e",
"cat6",
"cat6a",
"cat7",
"dac-active",
"dac-passive",
"mrj21-trunk",
"coaxial",
"mmf",
"mmf-om1",
"mmf-om2",
"mmf-om3",
"mmf-om4",
"smf",
"smf-os1",
"smf-os2",
"aoc",
"power"
],
"title": "Type",
"type": "string"
}
},
"required": [
"termination_a_type",
"termination_a_id",
"termination_b_type",
"termination_b_id"
],
"type": "object"
},
"WritableCircuit": {
"properties": {
"cid": {
"maxLength": 50,
"minLength": 1,
"title": "Circuit ID",
"type": "string"
},
"comments": {
"title": "Comments",
"type": "string"
},
"commit_rate": {
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"title": "Commit rate (Kbps)",
"type": "integer"
},
"created": {
"format": "date",
"readOnly": true,
"title": "Created",
"type": "string"
},
"custom_fields": {
"default": {},
"title": "Custom fields",
"type": "object"
},
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"install_date": {
"format": "date",
"nullable": true,
"title": "Date installed",
"type": "string"
},
"last_updated": {
"format": "date-time",
"readOnly": true,
"title": "Last updated",
"type": "string"
},
"provider": {
"title": "Provider",
"type": "integer"
},
"status": {
"enum": [
"planned",
"provisioning",
"active",
"offline",
"deprovisioning",
"decommissioned"
],
"title": "Status",
"type": "string"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
},
"tenant": {
"nullable": true,
"title": "Tenant",
"type": "integer"
},
"termination_a": {
"readOnly": true,
"title": "Termination a",
"type": "string"
},
"termination_z": {
"readOnly": true,
"title": "Termination z",
"type": "string"
},
"type": {
"title": "Type",
"type": "integer"
}
},
"required": [
"cid",
"provider",
"type"
],
"type": "object"
},
"WritableCircuitTermination": {
"properties": {
"cable": {
"$ref": "#/components/schemas/NestedCable"
},
"circuit": {
"title": "Circuit",
"type": "integer"
},
"connected_endpoint": {
"additionalProperties": {
"type": "string"
},
"description": "\nReturn the appropriate serializer for the type of connected object.\n",
"readOnly": true,
"title": "Connected endpoint",
"type": "object"
},
"connected_endpoint_type": {
"readOnly": true,
"title": "Connected endpoint type",
"type": "string"
},
"connection_status": {
"enum": [
false,
true
],
"title": "Connection status",
"type": "boolean"
},
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"port_speed": {
"maximum": 2147483647,
"minimum": 0,
"title": "Port speed (Kbps)",
"type": "integer"
},
"pp_info": {
"maxLength": 100,
"title": "Patch panel/port(s)",
"type": "string"
},
"site": {
"title": "Site",
"type": "integer"
},
"term_side": {
"enum": [
"A",
"Z"
],
"title": "Termination",
"type": "string"
},
"upstream_speed": {
"description": "Upstream speed, if different from port speed",
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"title": "Upstream speed (Kbps)",
"type": "integer"
},
"xconnect_id": {
"maxLength": 50,
"title": "Cross-connect ID",
"type": "string"
}
},
"required": [
"circuit",
"term_side",
"site",
"port_speed"
],
"type": "object"
},
"WritableCluster": {
"properties": {
"comments": {
"title": "Comments",
"type": "string"
},
"created": {
"format": "date",
"readOnly": true,
"title": "Created",
"type": "string"
},
"custom_fields": {
"default": {},
"title": "Custom fields",
"type": "object"
},
"device_count": {
"readOnly": true,
"title": "Device count",
"type": "integer"
},
"group": {
"nullable": true,
"title": "Group",
"type": "integer"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"last_updated": {
"format": "date-time",
"readOnly": true,
"title": "Last updated",
"type": "string"
},
"name": {
"maxLength": 100,
"minLength": 1,
"title": "Name",
"type": "string"
},
"site": {
"nullable": true,
"title": "Site",
"type": "integer"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
},
"tenant": {
"nullable": true,
"title": "Tenant",
"type": "integer"
},
"type": {
"title": "Type",
"type": "integer"
},
"virtualmachine_count": {
"readOnly": true,
"title": "Virtualmachine count",
"type": "integer"
}
},
"required": [
"name",
"type"
],
"type": "object"
},
"WritableConfigContext": {
"properties": {
"cluster_groups": {
"items": {
"type": "integer"
},
"type": "array",
"uniqueItems": true
},
"clusters": {
"items": {
"type": "integer"
},
"type": "array",
"uniqueItems": true
},
"data": {
"title": "Data",
"type": "string"
},
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"is_active": {
"title": "Is active",
"type": "boolean"
},
"name": {
"maxLength": 100,
"minLength": 1,
"title": "Name",
"type": "string"
},
"platforms": {
"items": {
"type": "integer"
},
"type": "array",
"uniqueItems": true
},
"regions": {
"items": {
"type": "integer"
},
"type": "array",
"uniqueItems": true
},
"roles": {
"items": {
"type": "integer"
},
"type": "array",
"uniqueItems": true
},
"sites": {
"items": {
"type": "integer"
},
"type": "array",
"uniqueItems": true
},
"tags": {
"items": {
"format": "slug",
"pattern": "^[-a-zA-Z0-9_]+$",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"tenant_groups": {
"items": {
"type": "integer"
},
"type": "array",
"uniqueItems": true
},
"tenants": {
"items": {
"type": "integer"
},
"type": "array",
"uniqueItems": true
},
"weight": {
"maximum": 32767,
"minimum": 0,
"title": "Weight",
"type": "integer"
}
},
"required": [
"name",
"data"
],
"type": "object"
},
"WritableConsolePort": {
"properties": {
"cable": {
"$ref": "#/components/schemas/NestedCable"
},
"connected_endpoint": {
"additionalProperties": {
"type": "string"
},
"description": "\nReturn the appropriate serializer for the type of connected object.\n",
"readOnly": true,
"title": "Connected endpoint",
"type": "object"
},
"connected_endpoint_type": {
"readOnly": true,
"title": "Connected endpoint type",
"type": "string"
},
"connection_status": {
"enum": [
false,
true
],
"title": "Connection status",
"type": "boolean"
},
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"device": {
"title": "Device",
"type": "integer"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
},
"type": {
"description": "Physical port type",
"enum": [
"de-9",
"db-25",
"rj-11",
"rj-12",
"rj-45",
"usb-a",
"usb-b",
"usb-c",
"usb-mini-a",
"usb-mini-b",
"usb-micro-a",
"usb-micro-b",
"other"
],
"title": "Type",
"type": "string"
}
},
"required": [
"device",
"name"
],
"type": "object"
},
"WritableConsolePortTemplate": {
"properties": {
"device_type": {
"title": "Device type",
"type": "integer"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"type": {
"enum": [
"de-9",
"db-25",
"rj-11",
"rj-12",
"rj-45",
"usb-a",
"usb-b",
"usb-c",
"usb-mini-a",
"usb-mini-b",
"usb-micro-a",
"usb-micro-b",
"other"
],
"title": "Type",
"type": "string"
}
},
"required": [
"device_type",
"name"
],
"type": "object"
},
"WritableConsoleServerPort": {
"properties": {
"cable": {
"$ref": "#/components/schemas/NestedCable"
},
"connected_endpoint": {
"additionalProperties": {
"type": "string"
},
"description": "\nReturn the appropriate serializer for the type of connected object.\n",
"readOnly": true,
"title": "Connected endpoint",
"type": "object"
},
"connected_endpoint_type": {
"readOnly": true,
"title": "Connected endpoint type",
"type": "string"
},
"connection_status": {
"enum": [
false,
true
],
"title": "Connection status",
"type": "boolean"
},
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"device": {
"title": "Device",
"type": "integer"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
},
"type": {
"description": "Physical port type",
"enum": [
"de-9",
"db-25",
"rj-11",
"rj-12",
"rj-45",
"usb-a",
"usb-b",
"usb-c",
"usb-mini-a",
"usb-mini-b",
"usb-micro-a",
"usb-micro-b",
"other"
],
"title": "Type",
"type": "string"
}
},
"required": [
"device",
"name"
],
"type": "object"
},
"WritableConsoleServerPortTemplate": {
"properties": {
"device_type": {
"title": "Device type",
"type": "integer"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"type": {
"enum": [
"de-9",
"db-25",
"rj-11",
"rj-12",
"rj-45",
"usb-a",
"usb-b",
"usb-c",
"usb-mini-a",
"usb-mini-b",
"usb-micro-a",
"usb-micro-b",
"other"
],
"title": "Type",
"type": "string"
}
},
"required": [
"device_type",
"name"
],
"type": "object"
},
"WritableDeviceBay": {
"properties": {
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"device": {
"title": "Device",
"type": "integer"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"installed_device": {
"nullable": true,
"title": "Installed device",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
}
},
"required": [
"device",
"name"
],
"type": "object"
},
"WritableDeviceBayTemplate": {
"properties": {
"device_type": {
"title": "Device type",
"type": "integer"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
}
},
"required": [
"device_type",
"name"
],
"type": "object"
},
"WritableDeviceInterface": {
"properties": {
"cable": {
"$ref": "#/components/schemas/NestedCable"
},
"connected_endpoint": {
"additionalProperties": {
"type": "string"
},
"description": "\nReturn the appropriate serializer for the type of connected object.\n",
"readOnly": true,
"title": "Connected endpoint",
"type": "object"
},
"connected_endpoint_type": {
"readOnly": true,
"title": "Connected endpoint type",
"type": "string"
},
"connection_status": {
"enum": [
false,
true
],
"title": "Connection status",
"type": "boolean"
},
"count_ipaddresses": {
"readOnly": true,
"title": "Count ipaddresses",
"type": "integer"
},
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"device": {
"title": "Device",
"type": "integer"
},
"enabled": {
"title": "Enabled",
"type": "boolean"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"lag": {
"nullable": true,
"title": "Parent LAG",
"type": "integer"
},
"mac_address": {
"nullable": true,
"title": "MAC Address",
"type": "string"
},
"mgmt_only": {
"description": "This interface is used only for out-of-band management",
"title": "OOB Management",
"type": "boolean"
},
"mode": {
"enum": [
"access",
"tagged",
"tagged-all"
],
"title": "Mode",
"type": "string"
},
"mtu": {
"maximum": 65536,
"minimum": 1,
"nullable": true,
"title": "MTU",
"type": "integer"
},
"name": {
"maxLength": 64,
"minLength": 1,
"title": "Name",
"type": "string"
},
"tagged_vlans": {
"items": {
"title": "Tagged VLANs",
"type": "integer"
},
"type": "array",
"uniqueItems": true
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"virtual",
"lag",
"100base-tx",
"1000base-t",
"2.5gbase-t",
"5gbase-t",
"10gbase-t",
"10gbase-cx4",
"1000base-x-gbic",
"1000base-x-sfp",
"10gbase-x-sfpp",
"10gbase-x-xfp",
"10gbase-x-xenpak",
"10gbase-x-x2",
"25gbase-x-sfp28",
"40gbase-x-qsfpp",
"50gbase-x-sfp28",
"100gbase-x-cfp",
"100gbase-x-cfp2",
"200gbase-x-cfp2",
"100gbase-x-cfp4",
"100gbase-x-cpak",
"100gbase-x-qsfp28",
"200gbase-x-qsfp56",
"400gbase-x-qsfpdd",
"400gbase-x-osfp",
"ieee802.11a",
"ieee802.11g",
"ieee802.11n",
"ieee802.11ac",
"ieee802.11ad",
"ieee802.11ax",
"gsm",
"cdma",
"lte",
"sonet-oc3",
"sonet-oc12",
"sonet-oc48",
"sonet-oc192",
"sonet-oc768",
"sonet-oc1920",
"sonet-oc3840",
"1gfc-sfp",
"2gfc-sfp",
"4gfc-sfp",
"8gfc-sfpp",
"16gfc-sfpp",
"32gfc-sfp28",
"128gfc-sfp28",
"infiniband-sdr",
"infiniband-ddr",
"infiniband-qdr",
"infiniband-fdr10",
"infiniband-fdr",
"infiniband-edr",
"infiniband-hdr",
"infiniband-ndr",
"infiniband-xdr",
"t1",
"e1",
"t3",
"e3",
"cisco-stackwise",
"cisco-stackwise-plus",
"cisco-flexstack",
"cisco-flexstack-plus",
"juniper-vcp",
"extreme-summitstack",
"extreme-summitstack-128",
"extreme-summitstack-256",
"extreme-summitstack-512",
"other"
],
"title": "Type",
"type": "string"
},
"untagged_vlan": {
"nullable": true,
"title": "Untagged VLAN",
"type": "integer"
}
},
"required": [
"device",
"name",
"type"
],
"type": "object"
},
"WritableDeviceType": {
"properties": {
"comments": {
"title": "Comments",
"type": "string"
},
"created": {
"format": "date",
"readOnly": true,
"title": "Created",
"type": "string"
},
"custom_fields": {
"default": {},
"title": "Custom fields",
"type": "object"
},
"device_count": {
"readOnly": true,
"title": "Device count",
"type": "integer"
},
"display_name": {
"readOnly": true,
"title": "Display name",
"type": "string"
},
"front_image": {
"format": "uri",
"readOnly": true,
"title": "Front image",
"type": "string"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"is_full_depth": {
"description": "Device consumes both front and rear rack faces",
"title": "Is full depth",
"type": "boolean"
},
"last_updated": {
"format": "date-time",
"readOnly": true,
"title": "Last updated",
"type": "string"
},
"manufacturer": {
"title": "Manufacturer",
"type": "integer"
},
"model": {
"maxLength": 50,
"minLength": 1,
"title": "Model",
"type": "string"
},
"part_number": {
"description": "Discrete part number (optional)",
"maxLength": 50,
"title": "Part number",
"type": "string"
},
"rear_image": {
"format": "uri",
"readOnly": true,
"title": "Rear image",
"type": "string"
},
"slug": {
"format": "slug",
"maxLength": 50,
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"title": "Slug",
"type": "string"
},
"subdevice_role": {
"description": "Parent devices house child devices in device bays. Leave blank if this device type is neither a parent nor a child.",
"enum": [
"parent",
"child"
],
"title": "Parent/child status",
"type": "string"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
},
"u_height": {
"maximum": 32767,
"minimum": 0,
"title": "Height (U)",
"type": "integer"
}
},
"required": [
"manufacturer",
"model",
"slug"
],
"type": "object"
},
"WritableDeviceWithConfigContext": {
"properties": {
"asset_tag": {
"description": "A unique tag used to identify this device",
"maxLength": 50,
"nullable": true,
"title": "Asset tag",
"type": "string"
},
"cluster": {
"nullable": true,
"title": "Cluster",
"type": "integer"
},
"comments": {
"title": "Comments",
"type": "string"
},
"config_context": {
"additionalProperties": {
"type": "string"
},
"readOnly": true,
"title": "Config context",
"type": "object"
},
"created": {
"format": "date",
"readOnly": true,
"title": "Created",
"type": "string"
},
"custom_fields": {
"default": {},
"title": "Custom fields",
"type": "object"
},
"device_role": {
"title": "Device role",
"type": "integer"
},
"device_type": {
"title": "Device type",
"type": "integer"
},
"display_name": {
"readOnly": true,
"title": "Display name",
"type": "string"
},
"face": {
"enum": [
"front",
"rear"
],
"title": "Rack face",
"type": "string"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"last_updated": {
"format": "date-time",
"readOnly": true,
"title": "Last updated",
"type": "string"
},
"local_context_data": {
"nullable": true,
"title": "Local context data",
"type": "string"
},
"name": {
"maxLength": 64,
"nullable": true,
"title": "Name",
"type": "string"
},
"parent_device": {
"$ref": "#/components/schemas/NestedDevice"
},
"platform": {
"nullable": true,
"title": "Platform",
"type": "integer"
},
"position": {
"description": "The lowest-numbered unit occupied by the device",
"maximum": 32767,
"minimum": 1,
"nullable": true,
"title": "Position (U)",
"type": "integer"
},
"primary_ip": {
"readOnly": true,
"title": "Primary ip",
"type": "string"
},
"primary_ip4": {
"nullable": true,
"title": "Primary IPv4",
"type": "integer"
},
"primary_ip6": {
"nullable": true,
"title": "Primary IPv6",
"type": "integer"
},
"rack": {
"nullable": true,
"title": "Rack",
"type": "integer"
},
"serial": {
"maxLength": 50,
"title": "Serial number",
"type": "string"
},
"site": {
"title": "Site",
"type": "integer"
},
"status": {
"enum": [
"offline",
"active",
"planned",
"staged",
"failed",
"inventory",
"decommissioning"
],
"title": "Status",
"type": "string"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
},
"tenant": {
"nullable": true,
"title": "Tenant",
"type": "integer"
},
"vc_position": {
"maximum": 255,
"minimum": 0,
"nullable": true,
"title": "Vc position",
"type": "integer"
},
"vc_priority": {
"maximum": 255,
"minimum": 0,
"nullable": true,
"title": "Vc priority",
"type": "integer"
},
"virtual_chassis": {
"nullable": true,
"title": "Virtual chassis",
"type": "integer"
}
},
"required": [
"device_type",
"device_role",
"site"
],
"type": "object"
},
"WritableExportTemplate": {
"properties": {
"content_type": {
"title": "Content type",
"type": "string"
},
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"file_extension": {
"description": "Extension to append to the rendered filename",
"maxLength": 15,
"title": "File extension",
"type": "string"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"mime_type": {
"description": "Defaults to <code>text/plain</code>",
"maxLength": 50,
"title": "MIME type",
"type": "string"
},
"name": {
"maxLength": 100,
"minLength": 1,
"title": "Name",
"type": "string"
},
"template_code": {
"description": "The list of objects being exported is passed as a context variable named <code>queryset</code>.",
"minLength": 1,
"title": "Template code",
"type": "string"
},
"template_language": {
"enum": [
"django",
"jinja2"
],
"title": "Template language",
"type": "string"
}
},
"required": [
"content_type",
"name",
"template_code"
],
"type": "object"
},
"WritableFrontPort": {
"properties": {
"cable": {
"$ref": "#/components/schemas/NestedCable"
},
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"device": {
"title": "Device",
"type": "integer"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 64,
"minLength": 1,
"title": "Name",
"type": "string"
},
"rear_port": {
"title": "Rear port",
"type": "integer"
},
"rear_port_position": {
"default": 1,
"maximum": 64,
"minimum": 1,
"title": "Rear port position",
"type": "integer"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"8p8c",
"110-punch",
"bnc",
"mrj21",
"fc",
"lc",
"lc-apc",
"lsh",
"lsh-apc",
"mpo",
"mtrj",
"sc",
"sc-apc",
"st"
],
"title": "Type",
"type": "string"
}
},
"required": [
"device",
"name",
"type",
"rear_port"
],
"type": "object"
},
"WritableFrontPortTemplate": {
"properties": {
"device_type": {
"title": "Device type",
"type": "integer"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 64,
"minLength": 1,
"title": "Name",
"type": "string"
},
"rear_port": {
"title": "Rear port",
"type": "integer"
},
"rear_port_position": {
"default": 1,
"maximum": 64,
"minimum": 1,
"title": "Rear port position",
"type": "integer"
},
"type": {
"enum": [
"8p8c",
"110-punch",
"bnc",
"mrj21",
"fc",
"lc",
"lc-apc",
"lsh",
"lsh-apc",
"mpo",
"mtrj",
"sc",
"sc-apc",
"st"
],
"title": "Type",
"type": "string"
}
},
"required": [
"device_type",
"name",
"type",
"rear_port"
],
"type": "object"
},
"WritableIPAddress": {
"properties": {
"address": {
"description": "IPv4 or IPv6 address (with mask)",
"title": "Address",
"type": "string"
},
"created": {
"format": "date",
"readOnly": true,
"title": "Created",
"type": "string"
},
"custom_fields": {
"default": {},
"title": "Custom fields",
"type": "object"
},
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"dns_name": {
"description": "Hostname or FQDN (not case-sensitive)",
"maxLength": 255,
"pattern": "^[0-9A-Za-z._-]+$",
"title": "DNS Name",
"type": "string"
},
"family": {
"readOnly": true,
"title": "Family",
"type": "string"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"interface": {
"nullable": true,
"title": "Interface",
"type": "integer"
},
"last_updated": {
"format": "date-time",
"readOnly": true,
"title": "Last updated",
"type": "string"
},
"nat_inside": {
"description": "The IP for which this address is the \"outside\" IP",
"nullable": true,
"title": "NAT (Inside)",
"type": "integer"
},
"nat_outside": {
"title": "Nat outside",
"type": "integer"
},
"role": {
"description": "The functional role of this IP",
"enum": [
"loopback",
"secondary",
"anycast",
"vip",
"vrrp",
"hsrp",
"glbp",
"carp"
],
"title": "Role",
"type": "string"
},
"status": {
"description": "The operational status of this IP",
"enum": [
"active",
"reserved",
"deprecated",
"dhcp"
],
"title": "Status",
"type": "string"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
},
"tenant": {
"nullable": true,
"title": "Tenant",
"type": "integer"
},
"vrf": {
"nullable": true,
"title": "VRF",
"type": "integer"
}
},
"required": [
"address",
"nat_outside"
],
"type": "object"
},
"WritableInterfaceTemplate": {
"properties": {
"device_type": {
"title": "Device type",
"type": "integer"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"mgmt_only": {
"title": "Management only",
"type": "boolean"
},
"name": {
"maxLength": 64,
"minLength": 1,
"title": "Name",
"type": "string"
},
"type": {
"enum": [
"virtual",
"lag",
"100base-tx",
"1000base-t",
"2.5gbase-t",
"5gbase-t",
"10gbase-t",
"10gbase-cx4",
"1000base-x-gbic",
"1000base-x-sfp",
"10gbase-x-sfpp",
"10gbase-x-xfp",
"10gbase-x-xenpak",
"10gbase-x-x2",
"25gbase-x-sfp28",
"40gbase-x-qsfpp",
"50gbase-x-sfp28",
"100gbase-x-cfp",
"100gbase-x-cfp2",
"200gbase-x-cfp2",
"100gbase-x-cfp4",
"100gbase-x-cpak",
"100gbase-x-qsfp28",
"200gbase-x-qsfp56",
"400gbase-x-qsfpdd",
"400gbase-x-osfp",
"ieee802.11a",
"ieee802.11g",
"ieee802.11n",
"ieee802.11ac",
"ieee802.11ad",
"ieee802.11ax",
"gsm",
"cdma",
"lte",
"sonet-oc3",
"sonet-oc12",
"sonet-oc48",
"sonet-oc192",
"sonet-oc768",
"sonet-oc1920",
"sonet-oc3840",
"1gfc-sfp",
"2gfc-sfp",
"4gfc-sfp",
"8gfc-sfpp",
"16gfc-sfpp",
"32gfc-sfp28",
"128gfc-sfp28",
"infiniband-sdr",
"infiniband-ddr",
"infiniband-qdr",
"infiniband-fdr10",
"infiniband-fdr",
"infiniband-edr",
"infiniband-hdr",
"infiniband-ndr",
"infiniband-xdr",
"t1",
"e1",
"t3",
"e3",
"cisco-stackwise",
"cisco-stackwise-plus",
"cisco-flexstack",
"cisco-flexstack-plus",
"juniper-vcp",
"extreme-summitstack",
"extreme-summitstack-128",
"extreme-summitstack-256",
"extreme-summitstack-512",
"other"
],
"title": "Type",
"type": "string"
}
},
"required": [
"device_type",
"name",
"type"
],
"type": "object"
},
"WritableInventoryItem": {
"properties": {
"asset_tag": {
"description": "A unique tag used to identify this item",
"maxLength": 50,
"nullable": true,
"title": "Asset tag",
"type": "string"
},
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"device": {
"title": "Device",
"type": "integer"
},
"discovered": {
"description": "This item was automatically discovered",
"title": "Discovered",
"type": "boolean"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"manufacturer": {
"nullable": true,
"title": "Manufacturer",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"parent": {
"nullable": true,
"title": "Parent",
"type": "integer"
},
"part_id": {
"description": "Manufacturer-assigned part identifier",
"maxLength": 50,
"title": "Part ID",
"type": "string"
},
"serial": {
"maxLength": 50,
"title": "Serial number",
"type": "string"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
}
},
"required": [
"device",
"name"
],
"type": "object"
},
"WritablePlatform": {
"properties": {
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"device_count": {
"readOnly": true,
"title": "Device count",
"type": "integer"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"manufacturer": {
"description": "Optionally limit this platform to devices of a certain manufacturer",
"nullable": true,
"title": "Manufacturer",
"type": "integer"
},
"name": {
"maxLength": 100,
"minLength": 1,
"title": "Name",
"type": "string"
},
"napalm_args": {
"description": "Additional arguments to pass when initiating the NAPALM driver (JSON format)",
"nullable": true,
"title": "NAPALM arguments",
"type": "string"
},
"napalm_driver": {
"description": "The name of the NAPALM driver to use when interacting with devices",
"maxLength": 50,
"title": "NAPALM driver",
"type": "string"
},
"slug": {
"format": "slug",
"maxLength": 100,
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"title": "Slug",
"type": "string"
},
"virtualmachine_count": {
"readOnly": true,
"title": "Virtualmachine count",
"type": "integer"
}
},
"required": [
"name",
"slug"
],
"type": "object"
},
"WritablePowerFeed": {
"properties": {
"amperage": {
"maximum": 32767,
"minimum": 1,
"title": "Amperage",
"type": "integer"
},
"comments": {
"title": "Comments",
"type": "string"
},
"created": {
"format": "date",
"readOnly": true,
"title": "Created",
"type": "string"
},
"custom_fields": {
"default": {},
"title": "Custom fields",
"type": "object"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"last_updated": {
"format": "date-time",
"readOnly": true,
"title": "Last updated",
"type": "string"
},
"max_utilization": {
"description": "Maximum permissible draw (percentage)",
"maximum": 100,
"minimum": 1,
"title": "Max utilization",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"phase": {
"enum": [
"single-phase",
"three-phase"
],
"title": "Phase",
"type": "string"
},
"power_panel": {
"title": "Power panel",
"type": "integer"
},
"rack": {
"nullable": true,
"title": "Rack",
"type": "integer"
},
"status": {
"enum": [
"offline",
"active",
"planned",
"failed"
],
"title": "Status",
"type": "string"
},
"supply": {
"enum": [
"ac",
"dc"
],
"title": "Supply",
"type": "string"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"primary",
"redundant"
],
"title": "Type",
"type": "string"
},
"voltage": {
"maximum": 32767,
"minimum": -32768,
"title": "Voltage",
"type": "integer"
}
},
"required": [
"power_panel",
"name"
],
"type": "object"
},
"WritablePowerOutlet": {
"properties": {
"cable": {
"$ref": "#/components/schemas/NestedCable"
},
"connected_endpoint": {
"additionalProperties": {
"type": "string"
},
"description": "\nReturn the appropriate serializer for the type of connected object.\n",
"readOnly": true,
"title": "Connected endpoint",
"type": "object"
},
"connected_endpoint_type": {
"readOnly": true,
"title": "Connected endpoint type",
"type": "string"
},
"connection_status": {
"enum": [
false,
true
],
"title": "Connection status",
"type": "boolean"
},
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"device": {
"title": "Device",
"type": "integer"
},
"feed_leg": {
"description": "Phase (for three-phase feeds)",
"enum": [
"A",
"B",
"C"
],
"title": "Feed leg",
"type": "string"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"power_port": {
"nullable": true,
"title": "Power port",
"type": "integer"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
},
"type": {
"description": "Physical port type",
"enum": [
"iec-60320-c5",
"iec-60320-c7",
"iec-60320-c13",
"iec-60320-c15",
"iec-60320-c19",
"iec-60309-p-n-e-4h",
"iec-60309-p-n-e-6h",
"iec-60309-p-n-e-9h",
"iec-60309-2p-e-4h",
"iec-60309-2p-e-6h",
"iec-60309-2p-e-9h",
"iec-60309-3p-e-4h",
"iec-60309-3p-e-6h",
"iec-60309-3p-e-9h",
"iec-60309-3p-n-e-4h",
"iec-60309-3p-n-e-6h",
"iec-60309-3p-n-e-9h",
"nema-1-15r",
"nema-5-15r",
"nema-5-20r",
"nema-5-30r",
"nema-5-50r",
"nema-6-15r",
"nema-6-20r",
"nema-6-30r",
"nema-6-50r",
"nema-10-30r",
"nema-10-50r",
"nema-14-20r",
"nema-14-30r",
"nema-14-50r",
"nema-14-60r",
"nema-l1-15r",
"nema-l5-15r",
"nema-l5-20r",
"nema-l5-30r",
"nema-l5-50r",
"nema-l6-15r",
"nema-l6-20r",
"nema-l6-30r",
"nema-l6-50r",
"nema-l10-30r",
"nema-l14-20r",
"nema-l14-30r",
"nema-l14-50r",
"nema-l14-60r",
"nema-l21-20r",
"nema-l21-30r",
"CS6360C",
"CS6364C",
"CS8164C",
"CS8264C",
"CS8364C",
"CS8464C",
"ita-e",
"ita-f",
"ita-g",
"ita-h",
"ita-i",
"ita-j",
"ita-k",
"ita-l",
"ita-m",
"ita-n",
"ita-o",
"hdot-cx"
],
"title": "Type",
"type": "string"
}
},
"required": [
"device",
"name"
],
"type": "object"
},
"WritablePowerOutletTemplate": {
"properties": {
"device_type": {
"title": "Device type",
"type": "integer"
},
"feed_leg": {
"description": "Phase (for three-phase feeds)",
"enum": [
"A",
"B",
"C"
],
"title": "Feed leg",
"type": "string"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"power_port": {
"nullable": true,
"title": "Power port",
"type": "integer"
},
"type": {
"enum": [
"iec-60320-c5",
"iec-60320-c7",
"iec-60320-c13",
"iec-60320-c15",
"iec-60320-c19",
"iec-60309-p-n-e-4h",
"iec-60309-p-n-e-6h",
"iec-60309-p-n-e-9h",
"iec-60309-2p-e-4h",
"iec-60309-2p-e-6h",
"iec-60309-2p-e-9h",
"iec-60309-3p-e-4h",
"iec-60309-3p-e-6h",
"iec-60309-3p-e-9h",
"iec-60309-3p-n-e-4h",
"iec-60309-3p-n-e-6h",
"iec-60309-3p-n-e-9h",
"nema-1-15r",
"nema-5-15r",
"nema-5-20r",
"nema-5-30r",
"nema-5-50r",
"nema-6-15r",
"nema-6-20r",
"nema-6-30r",
"nema-6-50r",
"nema-10-30r",
"nema-10-50r",
"nema-14-20r",
"nema-14-30r",
"nema-14-50r",
"nema-14-60r",
"nema-l1-15r",
"nema-l5-15r",
"nema-l5-20r",
"nema-l5-30r",
"nema-l5-50r",
"nema-l6-15r",
"nema-l6-20r",
"nema-l6-30r",
"nema-l6-50r",
"nema-l10-30r",
"nema-l14-20r",
"nema-l14-30r",
"nema-l14-50r",
"nema-l14-60r",
"nema-l21-20r",
"nema-l21-30r",
"CS6360C",
"CS6364C",
"CS8164C",
"CS8264C",
"CS8364C",
"CS8464C",
"ita-e",
"ita-f",
"ita-g",
"ita-h",
"ita-i",
"ita-j",
"ita-k",
"ita-l",
"ita-m",
"ita-n",
"ita-o",
"hdot-cx"
],
"title": "Type",
"type": "string"
}
},
"required": [
"device_type",
"name"
],
"type": "object"
},
"WritablePowerPanel": {
"properties": {
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"powerfeed_count": {
"readOnly": true,
"title": "Powerfeed count",
"type": "integer"
},
"rack_group": {
"nullable": true,
"title": "Rack group",
"type": "integer"
},
"site": {
"title": "Site",
"type": "integer"
}
},
"required": [
"site",
"name"
],
"type": "object"
},
"WritablePowerPort": {
"properties": {
"allocated_draw": {
"description": "Allocated power draw (watts)",
"maximum": 32767,
"minimum": 1,
"nullable": true,
"title": "Allocated draw",
"type": "integer"
},
"cable": {
"$ref": "#/components/schemas/NestedCable"
},
"connected_endpoint": {
"additionalProperties": {
"type": "string"
},
"description": "\nReturn the appropriate serializer for the type of connected object.\n",
"readOnly": true,
"title": "Connected endpoint",
"type": "object"
},
"connected_endpoint_type": {
"readOnly": true,
"title": "Connected endpoint type",
"type": "string"
},
"connection_status": {
"enum": [
false,
true
],
"title": "Connection status",
"type": "boolean"
},
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"device": {
"title": "Device",
"type": "integer"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"maximum_draw": {
"description": "Maximum power draw (watts)",
"maximum": 32767,
"minimum": 1,
"nullable": true,
"title": "Maximum draw",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
},
"type": {
"description": "Physical port type",
"enum": [
"iec-60320-c6",
"iec-60320-c8",
"iec-60320-c14",
"iec-60320-c16",
"iec-60320-c20",
"iec-60309-p-n-e-4h",
"iec-60309-p-n-e-6h",
"iec-60309-p-n-e-9h",
"iec-60309-2p-e-4h",
"iec-60309-2p-e-6h",
"iec-60309-2p-e-9h",
"iec-60309-3p-e-4h",
"iec-60309-3p-e-6h",
"iec-60309-3p-e-9h",
"iec-60309-3p-n-e-4h",
"iec-60309-3p-n-e-6h",
"iec-60309-3p-n-e-9h",
"nema-1-15p",
"nema-5-15p",
"nema-5-20p",
"nema-5-30p",
"nema-5-50p",
"nema-6-15p",
"nema-6-20p",
"nema-6-30p",
"nema-6-50p",
"nema-10-30p",
"nema-10-50p",
"nema-14-20p",
"nema-14-30p",
"nema-14-50p",
"nema-14-60p",
"nema-l1-15p",
"nema-l5-15p",
"nema-l5-20p",
"nema-l5-30p",
"nema-l5-50p",
"nema-l6-15p",
"nema-l6-20p",
"nema-l6-30p",
"nema-l6-50p",
"nema-l10-30p",
"nema-l14-20p",
"nema-l14-30p",
"nema-l14-50p",
"nema-l14-60p",
"nema-l21-20p",
"nema-l21-30p",
"cs6361c",
"cs6365c",
"cs8165c",
"cs8265c",
"cs8365c",
"cs8465c",
"ita-e",
"ita-f",
"ita-ef",
"ita-g",
"ita-h",
"ita-i",
"ita-j",
"ita-k",
"ita-l",
"ita-m",
"ita-n",
"ita-o"
],
"title": "Type",
"type": "string"
}
},
"required": [
"device",
"name"
],
"type": "object"
},
"WritablePowerPortTemplate": {
"properties": {
"allocated_draw": {
"description": "Allocated power draw (watts)",
"maximum": 32767,
"minimum": 1,
"nullable": true,
"title": "Allocated draw",
"type": "integer"
},
"device_type": {
"title": "Device type",
"type": "integer"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"maximum_draw": {
"description": "Maximum power draw (watts)",
"maximum": 32767,
"minimum": 1,
"nullable": true,
"title": "Maximum draw",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"type": {
"enum": [
"iec-60320-c6",
"iec-60320-c8",
"iec-60320-c14",
"iec-60320-c16",
"iec-60320-c20",
"iec-60309-p-n-e-4h",
"iec-60309-p-n-e-6h",
"iec-60309-p-n-e-9h",
"iec-60309-2p-e-4h",
"iec-60309-2p-e-6h",
"iec-60309-2p-e-9h",
"iec-60309-3p-e-4h",
"iec-60309-3p-e-6h",
"iec-60309-3p-e-9h",
"iec-60309-3p-n-e-4h",
"iec-60309-3p-n-e-6h",
"iec-60309-3p-n-e-9h",
"nema-1-15p",
"nema-5-15p",
"nema-5-20p",
"nema-5-30p",
"nema-5-50p",
"nema-6-15p",
"nema-6-20p",
"nema-6-30p",
"nema-6-50p",
"nema-10-30p",
"nema-10-50p",
"nema-14-20p",
"nema-14-30p",
"nema-14-50p",
"nema-14-60p",
"nema-l1-15p",
"nema-l5-15p",
"nema-l5-20p",
"nema-l5-30p",
"nema-l5-50p",
"nema-l6-15p",
"nema-l6-20p",
"nema-l6-30p",
"nema-l6-50p",
"nema-l10-30p",
"nema-l14-20p",
"nema-l14-30p",
"nema-l14-50p",
"nema-l14-60p",
"nema-l21-20p",
"nema-l21-30p",
"cs6361c",
"cs6365c",
"cs8165c",
"cs8265c",
"cs8365c",
"cs8465c",
"ita-e",
"ita-f",
"ita-ef",
"ita-g",
"ita-h",
"ita-i",
"ita-j",
"ita-k",
"ita-l",
"ita-m",
"ita-n",
"ita-o"
],
"title": "Type",
"type": "string"
}
},
"required": [
"device_type",
"name"
],
"type": "object"
},
"WritablePrefix": {
"properties": {
"created": {
"format": "date",
"readOnly": true,
"title": "Created",
"type": "string"
},
"custom_fields": {
"default": {},
"title": "Custom fields",
"type": "object"
},
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"family": {
"readOnly": true,
"title": "Family",
"type": "string"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"is_pool": {
"description": "All IP addresses within this prefix are considered usable",
"title": "Is a pool",
"type": "boolean"
},
"last_updated": {
"format": "date-time",
"readOnly": true,
"title": "Last updated",
"type": "string"
},
"prefix": {
"description": "IPv4 or IPv6 network with mask",
"title": "Prefix",
"type": "string"
},
"role": {
"description": "The primary function of this prefix",
"nullable": true,
"title": "Role",
"type": "integer"
},
"site": {
"nullable": true,
"title": "Site",
"type": "integer"
},
"status": {
"description": "Operational status of this prefix",
"enum": [
"container",
"active",
"reserved",
"deprecated"
],
"title": "Status",
"type": "string"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
},
"tenant": {
"nullable": true,
"title": "Tenant",
"type": "integer"
},
"vlan": {
"nullable": true,
"title": "VLAN",
"type": "integer"
},
"vrf": {
"nullable": true,
"title": "VRF",
"type": "integer"
}
},
"required": [
"prefix"
],
"type": "object"
},
"WritableRack": {
"properties": {
"asset_tag": {
"description": "A unique tag used to identify this rack",
"maxLength": 50,
"nullable": true,
"title": "Asset tag",
"type": "string"
},
"comments": {
"title": "Comments",
"type": "string"
},
"created": {
"format": "date",
"readOnly": true,
"title": "Created",
"type": "string"
},
"custom_fields": {
"default": {},
"title": "Custom fields",
"type": "object"
},
"desc_units": {
"description": "Units are numbered top-to-bottom",
"title": "Descending units",
"type": "boolean"
},
"device_count": {
"readOnly": true,
"title": "Device count",
"type": "integer"
},
"display_name": {
"readOnly": true,
"title": "Display name",
"type": "string"
},
"facility_id": {
"description": "Locally-assigned identifier",
"maxLength": 50,
"nullable": true,
"title": "Facility ID",
"type": "string"
},
"group": {
"description": "Assigned group",
"nullable": true,
"title": "Group",
"type": "integer"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"last_updated": {
"format": "date-time",
"readOnly": true,
"title": "Last updated",
"type": "string"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"outer_depth": {
"description": "Outer dimension of rack (depth)",
"maximum": 32767,
"minimum": 0,
"nullable": true,
"title": "Outer depth",
"type": "integer"
},
"outer_unit": {
"enum": [
"mm",
"in"
],
"title": "Outer unit",
"type": "string"
},
"outer_width": {
"description": "Outer dimension of rack (width)",
"maximum": 32767,
"minimum": 0,
"nullable": true,
"title": "Outer width",
"type": "integer"
},
"powerfeed_count": {
"readOnly": true,
"title": "Powerfeed count",
"type": "integer"
},
"role": {
"description": "Functional role",
"nullable": true,
"title": "Role",
"type": "integer"
},
"serial": {
"maxLength": 50,
"title": "Serial number",
"type": "string"
},
"site": {
"title": "Site",
"type": "integer"
},
"status": {
"enum": [
"reserved",
"available",
"planned",
"active",
"deprecated"
],
"title": "Status",
"type": "string"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
},
"tenant": {
"nullable": true,
"title": "Tenant",
"type": "integer"
},
"type": {
"enum": [
"2-post-frame",
"4-post-frame",
"4-post-cabinet",
"wall-frame",
"wall-cabinet"
],
"title": "Type",
"type": "string"
},
"u_height": {
"description": "Height in rack units",
"maximum": 100,
"minimum": 1,
"title": "Height (U)",
"type": "integer"
},
"width": {
"description": "Rail-to-rail width",
"enum": [
10,
19,
21,
23
],
"title": "Width",
"type": "integer"
}
},
"required": [
"name",
"site"
],
"type": "object"
},
"WritableRackGroup": {
"properties": {
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"parent": {
"nullable": true,
"title": "Parent",
"type": "integer"
},
"rack_count": {
"readOnly": true,
"title": "Rack count",
"type": "integer"
},
"site": {
"title": "Site",
"type": "integer"
},
"slug": {
"format": "slug",
"maxLength": 50,
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"title": "Slug",
"type": "string"
}
},
"required": [
"name",
"slug",
"site"
],
"type": "object"
},
"WritableRackReservation": {
"properties": {
"created": {
"format": "date",
"readOnly": true,
"title": "Created",
"type": "string"
},
"description": {
"maxLength": 200,
"minLength": 1,
"title": "Description",
"type": "string"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"rack": {
"title": "Rack",
"type": "integer"
},
"tenant": {
"nullable": true,
"title": "Tenant",
"type": "integer"
},
"units": {
"items": {
"maximum": 32767,
"minimum": 0,
"title": "Units",
"type": "integer"
},
"type": "array"
},
"user": {
"title": "User",
"type": "integer"
}
},
"required": [
"rack",
"units",
"user",
"description"
],
"type": "object"
},
"WritableRearPort": {
"properties": {
"cable": {
"$ref": "#/components/schemas/NestedCable"
},
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"device": {
"title": "Device",
"type": "integer"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 64,
"minLength": 1,
"title": "Name",
"type": "string"
},
"positions": {
"maximum": 64,
"minimum": 1,
"title": "Positions",
"type": "integer"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"8p8c",
"110-punch",
"bnc",
"mrj21",
"fc",
"lc",
"lc-apc",
"lsh",
"lsh-apc",
"mpo",
"mtrj",
"sc",
"sc-apc",
"st"
],
"title": "Type",
"type": "string"
}
},
"required": [
"device",
"name",
"type"
],
"type": "object"
},
"WritableRearPortTemplate": {
"properties": {
"device_type": {
"title": "Device type",
"type": "integer"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 64,
"minLength": 1,
"title": "Name",
"type": "string"
},
"positions": {
"maximum": 64,
"minimum": 1,
"title": "Positions",
"type": "integer"
},
"type": {
"enum": [
"8p8c",
"110-punch",
"bnc",
"mrj21",
"fc",
"lc",
"lc-apc",
"lsh",
"lsh-apc",
"mpo",
"mtrj",
"sc",
"sc-apc",
"st"
],
"title": "Type",
"type": "string"
}
},
"required": [
"device_type",
"name",
"type"
],
"type": "object"
},
"WritableRegion": {
"properties": {
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"parent": {
"nullable": true,
"title": "Parent",
"type": "integer"
},
"site_count": {
"readOnly": true,
"title": "Site count",
"type": "integer"
},
"slug": {
"format": "slug",
"maxLength": 50,
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"title": "Slug",
"type": "string"
}
},
"required": [
"name",
"slug"
],
"type": "object"
},
"WritableSecret": {
"properties": {
"created": {
"format": "date",
"readOnly": true,
"title": "Created",
"type": "string"
},
"custom_fields": {
"default": {},
"title": "Custom fields",
"type": "object"
},
"device": {
"title": "Device",
"type": "integer"
},
"hash": {
"minLength": 1,
"readOnly": true,
"title": "Hash",
"type": "string"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"last_updated": {
"format": "date-time",
"readOnly": true,
"title": "Last updated",
"type": "string"
},
"name": {
"maxLength": 100,
"title": "Name",
"type": "string"
},
"plaintext": {
"minLength": 1,
"title": "Plaintext",
"type": "string"
},
"role": {
"title": "Role",
"type": "integer"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
}
},
"required": [
"device",
"role",
"plaintext"
],
"type": "object"
},
"WritableService": {
"properties": {
"created": {
"format": "date",
"readOnly": true,
"title": "Created",
"type": "string"
},
"custom_fields": {
"default": {},
"title": "Custom fields",
"type": "object"
},
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"device": {
"nullable": true,
"title": "Device",
"type": "integer"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"ipaddresses": {
"items": {
"title": "IP addresses",
"type": "integer"
},
"type": "array",
"uniqueItems": true
},
"last_updated": {
"format": "date-time",
"readOnly": true,
"title": "Last updated",
"type": "string"
},
"name": {
"maxLength": 30,
"minLength": 1,
"title": "Name",
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"title": "Port number",
"type": "integer"
},
"protocol": {
"enum": [
"tcp",
"udp"
],
"title": "Protocol",
"type": "string"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
},
"virtual_machine": {
"nullable": true,
"title": "Virtual machine",
"type": "integer"
}
},
"required": [
"name",
"port",
"protocol"
],
"type": "object"
},
"WritableSite": {
"properties": {
"asn": {
"description": "32-bit autonomous system number",
"maximum": 4294967295,
"minimum": 1,
"nullable": true,
"title": "ASN",
"type": "integer"
},
"circuit_count": {
"readOnly": true,
"title": "Circuit count",
"type": "integer"
},
"comments": {
"title": "Comments",
"type": "string"
},
"contact_email": {
"format": "email",
"maxLength": 254,
"title": "Contact E-mail",
"type": "string"
},
"contact_name": {
"maxLength": 50,
"title": "Contact name",
"type": "string"
},
"contact_phone": {
"maxLength": 20,
"title": "Contact phone",
"type": "string"
},
"created": {
"format": "date",
"readOnly": true,
"title": "Created",
"type": "string"
},
"custom_fields": {
"default": {},
"title": "Custom fields",
"type": "object"
},
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"device_count": {
"readOnly": true,
"title": "Device count",
"type": "integer"
},
"facility": {
"description": "Local facility ID or description",
"maxLength": 50,
"title": "Facility",
"type": "string"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"last_updated": {
"format": "date-time",
"readOnly": true,
"title": "Last updated",
"type": "string"
},
"latitude": {
"description": "GPS coordinate (latitude)",
"format": "decimal",
"nullable": true,
"title": "Latitude",
"type": "string"
},
"longitude": {
"description": "GPS coordinate (longitude)",
"format": "decimal",
"nullable": true,
"title": "Longitude",
"type": "string"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"physical_address": {
"maxLength": 200,
"title": "Physical address",
"type": "string"
},
"prefix_count": {
"readOnly": true,
"title": "Prefix count",
"type": "integer"
},
"rack_count": {
"readOnly": true,
"title": "Rack count",
"type": "integer"
},
"region": {
"nullable": true,
"title": "Region",
"type": "integer"
},
"shipping_address": {
"maxLength": 200,
"title": "Shipping address",
"type": "string"
},
"slug": {
"format": "slug",
"maxLength": 50,
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"title": "Slug",
"type": "string"
},
"status": {
"enum": [
"active",
"planned",
"retired"
],
"title": "Status",
"type": "string"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
},
"tenant": {
"nullable": true,
"title": "Tenant",
"type": "integer"
},
"time_zone": {
"title": "Time zone",
"type": "string"
},
"virtualmachine_count": {
"readOnly": true,
"title": "Virtualmachine count",
"type": "integer"
},
"vlan_count": {
"readOnly": true,
"title": "Vlan count",
"type": "integer"
}
},
"required": [
"name",
"slug"
],
"type": "object"
},
"WritableTenant": {
"properties": {
"circuit_count": {
"readOnly": true,
"title": "Circuit count",
"type": "integer"
},
"cluster_count": {
"readOnly": true,
"title": "Cluster count",
"type": "integer"
},
"comments": {
"title": "Comments",
"type": "string"
},
"created": {
"format": "date",
"readOnly": true,
"title": "Created",
"type": "string"
},
"custom_fields": {
"default": {},
"title": "Custom fields",
"type": "object"
},
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"device_count": {
"readOnly": true,
"title": "Device count",
"type": "integer"
},
"group": {
"nullable": true,
"title": "Group",
"type": "integer"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"ipaddress_count": {
"readOnly": true,
"title": "Ipaddress count",
"type": "integer"
},
"last_updated": {
"format": "date-time",
"readOnly": true,
"title": "Last updated",
"type": "string"
},
"name": {
"maxLength": 30,
"minLength": 1,
"title": "Name",
"type": "string"
},
"prefix_count": {
"readOnly": true,
"title": "Prefix count",
"type": "integer"
},
"rack_count": {
"readOnly": true,
"title": "Rack count",
"type": "integer"
},
"site_count": {
"readOnly": true,
"title": "Site count",
"type": "integer"
},
"slug": {
"format": "slug",
"maxLength": 50,
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"title": "Slug",
"type": "string"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
},
"virtualmachine_count": {
"readOnly": true,
"title": "Virtualmachine count",
"type": "integer"
},
"vlan_count": {
"readOnly": true,
"title": "Vlan count",
"type": "integer"
},
"vrf_count": {
"readOnly": true,
"title": "Vrf count",
"type": "integer"
}
},
"required": [
"name",
"slug"
],
"type": "object"
},
"WritableTenantGroup": {
"properties": {
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"parent": {
"nullable": true,
"title": "Parent",
"type": "integer"
},
"slug": {
"format": "slug",
"maxLength": 50,
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"title": "Slug",
"type": "string"
},
"tenant_count": {
"readOnly": true,
"title": "Tenant count",
"type": "integer"
}
},
"required": [
"name",
"slug"
],
"type": "object"
},
"WritableVLAN": {
"properties": {
"created": {
"format": "date",
"readOnly": true,
"title": "Created",
"type": "string"
},
"custom_fields": {
"default": {},
"title": "Custom fields",
"type": "object"
},
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"display_name": {
"readOnly": true,
"title": "Display name",
"type": "string"
},
"group": {
"nullable": true,
"title": "Group",
"type": "integer"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"last_updated": {
"format": "date-time",
"readOnly": true,
"title": "Last updated",
"type": "string"
},
"name": {
"maxLength": 64,
"minLength": 1,
"title": "Name",
"type": "string"
},
"prefix_count": {
"readOnly": true,
"title": "Prefix count",
"type": "integer"
},
"role": {
"nullable": true,
"title": "Role",
"type": "integer"
},
"site": {
"nullable": true,
"title": "Site",
"type": "integer"
},
"status": {
"enum": [
"active",
"reserved",
"deprecated"
],
"title": "Status",
"type": "string"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
},
"tenant": {
"nullable": true,
"title": "Tenant",
"type": "integer"
},
"vid": {
"maximum": 4094,
"minimum": 1,
"title": "ID",
"type": "integer"
}
},
"required": [
"vid",
"name"
],
"type": "object"
},
"WritableVLANGroup": {
"properties": {
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"site": {
"nullable": true,
"title": "Site",
"type": "integer"
},
"slug": {
"format": "slug",
"maxLength": 50,
"minLength": 1,
"pattern": "^[-a-zA-Z0-9_]+$",
"title": "Slug",
"type": "string"
},
"vlan_count": {
"readOnly": true,
"title": "Vlan count",
"type": "integer"
}
},
"required": [
"name",
"slug"
],
"type": "object"
},
"WritableVRF": {
"properties": {
"created": {
"format": "date",
"readOnly": true,
"title": "Created",
"type": "string"
},
"custom_fields": {
"default": {},
"title": "Custom fields",
"type": "object"
},
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"display_name": {
"readOnly": true,
"title": "Display name",
"type": "string"
},
"enforce_unique": {
"description": "Prevent duplicate prefixes/IP addresses within this VRF",
"title": "Enforce unique space",
"type": "boolean"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"ipaddress_count": {
"readOnly": true,
"title": "Ipaddress count",
"type": "integer"
},
"last_updated": {
"format": "date-time",
"readOnly": true,
"title": "Last updated",
"type": "string"
},
"name": {
"maxLength": 50,
"minLength": 1,
"title": "Name",
"type": "string"
},
"prefix_count": {
"readOnly": true,
"title": "Prefix count",
"type": "integer"
},
"rd": {
"description": "Unique route distinguisher (as defined in RFC 4364)",
"maxLength": 21,
"nullable": true,
"title": "Route distinguisher",
"type": "string"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
},
"tenant": {
"nullable": true,
"title": "Tenant",
"type": "integer"
}
},
"required": [
"name"
],
"type": "object"
},
"WritableVirtualChassis": {
"properties": {
"domain": {
"maxLength": 30,
"title": "Domain",
"type": "string"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"master": {
"title": "Master",
"type": "integer"
},
"member_count": {
"readOnly": true,
"title": "Member count",
"type": "integer"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
}
},
"required": [
"master"
],
"type": "object"
},
"WritableVirtualMachineInterface": {
"properties": {
"description": {
"maxLength": 200,
"title": "Description",
"type": "string"
},
"enabled": {
"title": "Enabled",
"type": "boolean"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"mac_address": {
"nullable": true,
"title": "MAC Address",
"type": "string"
},
"mode": {
"enum": [
"access",
"tagged",
"tagged-all"
],
"title": "Mode",
"type": "string"
},
"mtu": {
"maximum": 65536,
"minimum": 1,
"nullable": true,
"title": "MTU",
"type": "integer"
},
"name": {
"maxLength": 64,
"minLength": 1,
"title": "Name",
"type": "string"
},
"tagged_vlans": {
"items": {
"title": "Tagged VLANs",
"type": "integer"
},
"type": "array",
"uniqueItems": true
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"virtual",
"lag",
"100base-tx",
"1000base-t",
"2.5gbase-t",
"5gbase-t",
"10gbase-t",
"10gbase-cx4",
"1000base-x-gbic",
"1000base-x-sfp",
"10gbase-x-sfpp",
"10gbase-x-xfp",
"10gbase-x-xenpak",
"10gbase-x-x2",
"25gbase-x-sfp28",
"40gbase-x-qsfpp",
"50gbase-x-sfp28",
"100gbase-x-cfp",
"100gbase-x-cfp2",
"200gbase-x-cfp2",
"100gbase-x-cfp4",
"100gbase-x-cpak",
"100gbase-x-qsfp28",
"200gbase-x-qsfp56",
"400gbase-x-qsfpdd",
"400gbase-x-osfp",
"ieee802.11a",
"ieee802.11g",
"ieee802.11n",
"ieee802.11ac",
"ieee802.11ad",
"ieee802.11ax",
"gsm",
"cdma",
"lte",
"sonet-oc3",
"sonet-oc12",
"sonet-oc48",
"sonet-oc192",
"sonet-oc768",
"sonet-oc1920",
"sonet-oc3840",
"1gfc-sfp",
"2gfc-sfp",
"4gfc-sfp",
"8gfc-sfpp",
"16gfc-sfpp",
"32gfc-sfp28",
"128gfc-sfp28",
"infiniband-sdr",
"infiniband-ddr",
"infiniband-qdr",
"infiniband-fdr10",
"infiniband-fdr",
"infiniband-edr",
"infiniband-hdr",
"infiniband-ndr",
"infiniband-xdr",
"t1",
"e1",
"t3",
"e3",
"cisco-stackwise",
"cisco-stackwise-plus",
"cisco-flexstack",
"cisco-flexstack-plus",
"juniper-vcp",
"extreme-summitstack",
"extreme-summitstack-128",
"extreme-summitstack-256",
"extreme-summitstack-512",
"other"
],
"title": "Type",
"type": "string"
},
"untagged_vlan": {
"nullable": true,
"title": "Untagged VLAN",
"type": "integer"
},
"virtual_machine": {
"nullable": true,
"title": "Virtual machine",
"type": "integer"
}
},
"required": [
"name",
"type"
],
"type": "object"
},
"WritableVirtualMachineWithConfigContext": {
"properties": {
"cluster": {
"title": "Cluster",
"type": "integer"
},
"comments": {
"title": "Comments",
"type": "string"
},
"config_context": {
"additionalProperties": {
"type": "string"
},
"readOnly": true,
"title": "Config context",
"type": "object"
},
"created": {
"format": "date",
"readOnly": true,
"title": "Created",
"type": "string"
},
"custom_fields": {
"default": {},
"title": "Custom fields",
"type": "object"
},
"disk": {
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"title": "Disk (GB)",
"type": "integer"
},
"id": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"last_updated": {
"format": "date-time",
"readOnly": true,
"title": "Last updated",
"type": "string"
},
"local_context_data": {
"nullable": true,
"title": "Local context data",
"type": "string"
},
"memory": {
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"title": "Memory (MB)",
"type": "integer"
},
"name": {
"maxLength": 64,
"minLength": 1,
"title": "Name",
"type": "string"
},
"platform": {
"nullable": true,
"title": "Platform",
"type": "integer"
},
"primary_ip": {
"readOnly": true,
"title": "Primary ip",
"type": "string"
},
"primary_ip4": {
"nullable": true,
"title": "Primary IPv4",
"type": "integer"
},
"primary_ip6": {
"nullable": true,
"title": "Primary IPv6",
"type": "integer"
},
"role": {
"nullable": true,
"title": "Role",
"type": "integer"
},
"site": {
"readOnly": true,
"title": "Site",
"type": "string"
},
"status": {
"enum": [
"offline",
"active",
"planned",
"staged",
"failed",
"decommissioning"
],
"title": "Status",
"type": "string"
},
"tags": {
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
},
"tenant": {
"nullable": true,
"title": "Tenant",
"type": "integer"
},
"vcpus": {
"maximum": 32767,
"minimum": 0,
"nullable": true,
"title": "VCPUs",
"type": "integer"
}
},
"required": [
"name",
"cluster"
],
"type": "object"
}
},
"securitySchemes": {
"Bearer": {
"in": "header",
"name": "Authorization",
"type": "apiKey"
}
}
}
}