-
-
Save davcamer/067fcabf455e9eefa1064cb6584b6877 to your computer and use it in GitHub Desktop.
OpenAPI definition for netbox v2 API generated with drf-yasg
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "swagger": "2.0", | |
| "info": { | |
| "title": "NetBox API", | |
| "description": "API to access NetBox", | |
| "termsOfService": "https://github.com/digitalocean/netbox", | |
| "contact": { | |
| "email": "netbox@digitalocean.com" | |
| }, | |
| "license": { | |
| "name": "Apache v2 License" | |
| }, | |
| "version": "2.2" | |
| }, | |
| "host": "localhost:8000", | |
| "schemes": [ | |
| "http" | |
| ], | |
| "basePath": "/api", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "securityDefinitions": { | |
| "basic": { | |
| "type": "basic" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "basic": [] | |
| } | |
| ], | |
| "paths": { | |
| "/circuits/_choices/": { | |
| "get": { | |
| "operationId": "circuits__choices_list", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "circuits" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/circuits/_choices/{id}/": { | |
| "get": { | |
| "operationId": "circuits__choices_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "circuits" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ] | |
| }, | |
| "/circuits/circuit-terminations/": { | |
| "get": { | |
| "operationId": "circuits_circuit-terminations_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "term_side", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "port_speed", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "number" | |
| }, | |
| { | |
| "name": "upstream_speed", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "number" | |
| }, | |
| { | |
| "name": "xconnect_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "q", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "circuit_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "site_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "site", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/CircuitTermination" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "circuits" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "circuits_circuit-terminations_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableCircuitTermination" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableCircuitTermination" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "circuits" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/circuits/circuit-terminations/{id}/": { | |
| "get": { | |
| "operationId": "circuits_circuit-terminations_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/CircuitTermination" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "circuits" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "circuits_circuit-terminations_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableCircuitTermination" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableCircuitTermination" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "circuits" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "circuits_circuit-terminations_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableCircuitTermination" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableCircuitTermination" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "circuits" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "circuits_circuit-terminations_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "circuits" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this circuit termination.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/circuits/circuit-types/": { | |
| "get": { | |
| "operationId": "circuits_circuit-types_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "slug", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/CircuitType" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "circuits" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "circuits_circuit-types_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/CircuitType" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/CircuitType" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "circuits" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/circuits/circuit-types/{id}/": { | |
| "get": { | |
| "operationId": "circuits_circuit-types_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/CircuitType" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "circuits" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "circuits_circuit-types_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/CircuitType" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/CircuitType" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "circuits" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "circuits_circuit-types_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/CircuitType" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/CircuitType" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "circuits" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "circuits_circuit-types_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "circuits" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this circuit type.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/circuits/circuits/": { | |
| "get": { | |
| "operationId": "circuits_circuits_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "cid", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "install_date", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "commit_rate", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "number" | |
| }, | |
| { | |
| "name": "id__in", | |
| "in": "query", | |
| "description": "Multiple values may be separated by commas.", | |
| "required": false, | |
| "type": "number" | |
| }, | |
| { | |
| "name": "q", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "provider_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "provider", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "type_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "type", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "tenant_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "tenant", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "site_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "site", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Circuit" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "circuits" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "circuits_circuits_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableCircuit" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableCircuit" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "circuits" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/circuits/circuits/{id}/": { | |
| "get": { | |
| "operationId": "circuits_circuits_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/Circuit" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "circuits" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "circuits_circuits_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableCircuit" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableCircuit" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "circuits" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "circuits_circuits_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableCircuit" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableCircuit" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "circuits" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "circuits_circuits_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "circuits" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this circuit.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/circuits/providers/": { | |
| "get": { | |
| "operationId": "circuits_providers_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "slug", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "asn", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "number" | |
| }, | |
| { | |
| "name": "account", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "id__in", | |
| "in": "query", | |
| "description": "Multiple values may be separated by commas.", | |
| "required": false, | |
| "type": "number" | |
| }, | |
| { | |
| "name": "q", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "site_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "site", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Provider" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "circuits" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "circuits_providers_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableProvider" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableProvider" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "circuits" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/circuits/providers/{id}/": { | |
| "get": { | |
| "operationId": "circuits_providers_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/Provider" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "circuits" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "circuits_providers_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableProvider" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableProvider" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "circuits" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "circuits_providers_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableProvider" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableProvider" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "circuits" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "circuits_providers_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "circuits" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this provider.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/circuits/providers/{id}/graphs/": { | |
| "get": { | |
| "operationId": "circuits_providers_graphs", | |
| "description": "A convenience method for rendering graphs for a particular provider.", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/Provider" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "circuits" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this provider.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/dcim/_choices/": { | |
| "get": { | |
| "operationId": "dcim__choices_list", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/dcim/_choices/{id}/": { | |
| "get": { | |
| "operationId": "dcim__choices_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ] | |
| }, | |
| "/dcim/connected-device/": { | |
| "get": { | |
| "operationId": "dcim_connected-device_list", | |
| "description": "This endpoint allows a user to determine what device (if any) is connected to a given peer device and peer\ninterface. This is useful in a situation where a device boots with no configuration, but can detect its neighbors\nvia a protocol such as LLDP. Two query parameters must be included in the request:\n\n* `peer-device`: The name of the peer device\n* `peer-interface`: The name of the peer interface", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/dcim/console-connections/": { | |
| "get": { | |
| "operationId": "dcim_console-connections_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "connection_status", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "site", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "device", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ConsolePort" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/dcim/console-port-templates/": { | |
| "get": { | |
| "operationId": "dcim_console-port-templates_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "devicetype_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ConsolePortTemplate" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "dcim_console-port-templates_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableConsolePortTemplate" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableConsolePortTemplate" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/dcim/console-port-templates/{id}/": { | |
| "get": { | |
| "operationId": "dcim_console-port-templates_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/ConsolePortTemplate" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "dcim_console-port-templates_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableConsolePortTemplate" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableConsolePortTemplate" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "dcim_console-port-templates_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableConsolePortTemplate" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableConsolePortTemplate" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "dcim_console-port-templates_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this console port template.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/dcim/console-ports/": { | |
| "get": { | |
| "operationId": "dcim_console-ports_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "device_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "device", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ConsolePort" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "dcim_console-ports_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableConsolePort" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableConsolePort" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/dcim/console-ports/{id}/": { | |
| "get": { | |
| "operationId": "dcim_console-ports_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/ConsolePort" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "dcim_console-ports_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableConsolePort" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableConsolePort" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "dcim_console-ports_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableConsolePort" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableConsolePort" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "dcim_console-ports_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this console port.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/dcim/console-server-port-templates/": { | |
| "get": { | |
| "operationId": "dcim_console-server-port-templates_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "devicetype_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ConsoleServerPortTemplate" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "dcim_console-server-port-templates_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableConsoleServerPortTemplate" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableConsoleServerPortTemplate" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/dcim/console-server-port-templates/{id}/": { | |
| "get": { | |
| "operationId": "dcim_console-server-port-templates_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/ConsoleServerPortTemplate" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "dcim_console-server-port-templates_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableConsoleServerPortTemplate" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableConsoleServerPortTemplate" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "dcim_console-server-port-templates_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableConsoleServerPortTemplate" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableConsoleServerPortTemplate" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "dcim_console-server-port-templates_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this console server port template.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/dcim/console-server-ports/": { | |
| "get": { | |
| "operationId": "dcim_console-server-ports_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "device_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "device", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ConsoleServerPort" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "dcim_console-server-ports_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableConsoleServerPort" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableConsoleServerPort" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/dcim/console-server-ports/{id}/": { | |
| "get": { | |
| "operationId": "dcim_console-server-ports_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/ConsoleServerPort" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "dcim_console-server-ports_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableConsoleServerPort" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableConsoleServerPort" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "dcim_console-server-ports_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableConsoleServerPort" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableConsoleServerPort" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "dcim_console-server-ports_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this console server port.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/dcim/device-bay-templates/": { | |
| "get": { | |
| "operationId": "dcim_device-bay-templates_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "devicetype_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/DeviceBayTemplate" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "dcim_device-bay-templates_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableDeviceBayTemplate" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableDeviceBayTemplate" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/dcim/device-bay-templates/{id}/": { | |
| "get": { | |
| "operationId": "dcim_device-bay-templates_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/DeviceBayTemplate" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "dcim_device-bay-templates_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableDeviceBayTemplate" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableDeviceBayTemplate" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "dcim_device-bay-templates_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableDeviceBayTemplate" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableDeviceBayTemplate" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "dcim_device-bay-templates_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this device bay template.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/dcim/device-bays/": { | |
| "get": { | |
| "operationId": "dcim_device-bays_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "device_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "device", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/DeviceBay" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "dcim_device-bays_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableDeviceBay" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableDeviceBay" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/dcim/device-bays/{id}/": { | |
| "get": { | |
| "operationId": "dcim_device-bays_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/DeviceBay" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "dcim_device-bays_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableDeviceBay" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableDeviceBay" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "dcim_device-bays_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableDeviceBay" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableDeviceBay" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "dcim_device-bays_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this device bay.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/dcim/device-roles/": { | |
| "get": { | |
| "operationId": "dcim_device-roles_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "slug", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "color", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "vm_role", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/DeviceRole" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "dcim_device-roles_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/DeviceRole" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/DeviceRole" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/dcim/device-roles/{id}/": { | |
| "get": { | |
| "operationId": "dcim_device-roles_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/DeviceRole" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "dcim_device-roles_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/DeviceRole" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/DeviceRole" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "dcim_device-roles_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/DeviceRole" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/DeviceRole" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "dcim_device-roles_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this device role.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/dcim/device-types/": { | |
| "get": { | |
| "operationId": "dcim_device-types_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "model", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "slug", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "part_number", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "u_height", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "number" | |
| }, | |
| { | |
| "name": "is_full_depth", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "is_console_server", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "is_pdu", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "is_network_device", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "subdevice_role", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "id__in", | |
| "in": "query", | |
| "description": "Multiple values may be separated by commas.", | |
| "required": false, | |
| "type": "number" | |
| }, | |
| { | |
| "name": "q", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "manufacturer_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "manufacturer", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/DeviceType" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "dcim_device-types_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableDeviceType" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableDeviceType" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/dcim/device-types/{id}/": { | |
| "get": { | |
| "operationId": "dcim_device-types_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/DeviceType" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "dcim_device-types_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableDeviceType" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableDeviceType" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "dcim_device-types_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableDeviceType" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableDeviceType" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "dcim_device-types_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this device type.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/dcim/devices/": { | |
| "get": { | |
| "operationId": "dcim_devices_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "serial", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "position", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "number" | |
| }, | |
| { | |
| "name": "id__in", | |
| "in": "query", | |
| "description": "Multiple values may be separated by commas.", | |
| "required": false, | |
| "type": "number" | |
| }, | |
| { | |
| "name": "q", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "manufacturer_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "manufacturer", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "device_type_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "role_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "role", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "tenant_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "tenant", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "platform_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "platform", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "asset_tag", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "site_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "site", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "rack_group_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "rack_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "cluster_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "model", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "status", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "is_full_depth", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "is_console_server", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "is_pdu", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "is_network_device", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "mac_address", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "has_primary_ip", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Device" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "dcim_devices_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableDevice" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableDevice" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/dcim/devices/{id}/": { | |
| "get": { | |
| "operationId": "dcim_devices_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/Device" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "dcim_devices_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableDevice" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableDevice" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "dcim_devices_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableDevice" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableDevice" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "dcim_devices_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this device.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/dcim/devices/{id}/napalm/": { | |
| "get": { | |
| "operationId": "dcim_devices_napalm", | |
| "description": "Execute a NAPALM method on a Device", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/Device" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this device.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/dcim/interface-connections/": { | |
| "get": { | |
| "operationId": "dcim_interface-connections_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "connection_status", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "site", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "device", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/InterfaceConnection" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "dcim_interface-connections_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableInterfaceConnection" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableInterfaceConnection" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/dcim/interface-connections/{id}/": { | |
| "get": { | |
| "operationId": "dcim_interface-connections_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/InterfaceConnection" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "dcim_interface-connections_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableInterfaceConnection" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableInterfaceConnection" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "dcim_interface-connections_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableInterfaceConnection" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableInterfaceConnection" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "dcim_interface-connections_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this interface connection.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/dcim/interface-templates/": { | |
| "get": { | |
| "operationId": "dcim_interface-templates_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "form_factor", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "mgmt_only", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "devicetype_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/InterfaceTemplate" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "dcim_interface-templates_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableInterfaceTemplate" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableInterfaceTemplate" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/dcim/interface-templates/{id}/": { | |
| "get": { | |
| "operationId": "dcim_interface-templates_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/InterfaceTemplate" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "dcim_interface-templates_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableInterfaceTemplate" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableInterfaceTemplate" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "dcim_interface-templates_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableInterfaceTemplate" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableInterfaceTemplate" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "dcim_interface-templates_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this interface template.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/dcim/interfaces/": { | |
| "get": { | |
| "operationId": "dcim_interfaces_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "form_factor", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "enabled", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "mtu", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "number" | |
| }, | |
| { | |
| "name": "mgmt_only", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "device", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "device_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "number" | |
| }, | |
| { | |
| "name": "type", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "lag_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "mac_address", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Interface" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "dcim_interfaces_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableInterface" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableInterface" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/dcim/interfaces/{id}/": { | |
| "get": { | |
| "operationId": "dcim_interfaces_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/Interface" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "dcim_interfaces_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableInterface" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableInterface" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "dcim_interfaces_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableInterface" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableInterface" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "dcim_interfaces_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this interface.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/dcim/interfaces/{id}/graphs/": { | |
| "get": { | |
| "operationId": "dcim_interfaces_graphs", | |
| "description": "A convenience method for rendering graphs for a particular interface.", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/Interface" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this interface.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/dcim/inventory-items/": { | |
| "get": { | |
| "operationId": "dcim_inventory-items_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "part_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "serial", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "asset_tag", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "discovered", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "device_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "device", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "q", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "parent_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "manufacturer_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "manufacturer", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/InventoryItem" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "dcim_inventory-items_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableInventoryItem" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableInventoryItem" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/dcim/inventory-items/{id}/": { | |
| "get": { | |
| "operationId": "dcim_inventory-items_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/InventoryItem" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "dcim_inventory-items_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableInventoryItem" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableInventoryItem" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "dcim_inventory-items_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableInventoryItem" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableInventoryItem" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "dcim_inventory-items_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this inventory item.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/dcim/manufacturers/": { | |
| "get": { | |
| "operationId": "dcim_manufacturers_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "slug", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Manufacturer" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "dcim_manufacturers_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/Manufacturer" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/Manufacturer" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/dcim/manufacturers/{id}/": { | |
| "get": { | |
| "operationId": "dcim_manufacturers_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/Manufacturer" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "dcim_manufacturers_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/Manufacturer" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/Manufacturer" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "dcim_manufacturers_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/Manufacturer" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/Manufacturer" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "dcim_manufacturers_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this manufacturer.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/dcim/platforms/": { | |
| "get": { | |
| "operationId": "dcim_platforms_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "slug", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Platform" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "dcim_platforms_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/Platform" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/Platform" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/dcim/platforms/{id}/": { | |
| "get": { | |
| "operationId": "dcim_platforms_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/Platform" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "dcim_platforms_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/Platform" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/Platform" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "dcim_platforms_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/Platform" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/Platform" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "dcim_platforms_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this platform.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/dcim/power-connections/": { | |
| "get": { | |
| "operationId": "dcim_power-connections_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "connection_status", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "site", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "device", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/PowerPort" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/dcim/power-outlet-templates/": { | |
| "get": { | |
| "operationId": "dcim_power-outlet-templates_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "devicetype_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/PowerOutletTemplate" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "dcim_power-outlet-templates_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritablePowerOutletTemplate" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritablePowerOutletTemplate" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/dcim/power-outlet-templates/{id}/": { | |
| "get": { | |
| "operationId": "dcim_power-outlet-templates_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/PowerOutletTemplate" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "dcim_power-outlet-templates_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritablePowerOutletTemplate" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritablePowerOutletTemplate" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "dcim_power-outlet-templates_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritablePowerOutletTemplate" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritablePowerOutletTemplate" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "dcim_power-outlet-templates_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this power outlet template.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/dcim/power-outlets/": { | |
| "get": { | |
| "operationId": "dcim_power-outlets_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "device_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "device", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/PowerOutlet" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "dcim_power-outlets_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritablePowerOutlet" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritablePowerOutlet" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/dcim/power-outlets/{id}/": { | |
| "get": { | |
| "operationId": "dcim_power-outlets_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/PowerOutlet" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "dcim_power-outlets_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritablePowerOutlet" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritablePowerOutlet" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "dcim_power-outlets_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritablePowerOutlet" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritablePowerOutlet" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "dcim_power-outlets_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this power outlet.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/dcim/power-port-templates/": { | |
| "get": { | |
| "operationId": "dcim_power-port-templates_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "devicetype_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/PowerPortTemplate" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "dcim_power-port-templates_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritablePowerPortTemplate" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritablePowerPortTemplate" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/dcim/power-port-templates/{id}/": { | |
| "get": { | |
| "operationId": "dcim_power-port-templates_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/PowerPortTemplate" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "dcim_power-port-templates_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritablePowerPortTemplate" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritablePowerPortTemplate" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "dcim_power-port-templates_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritablePowerPortTemplate" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritablePowerPortTemplate" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "dcim_power-port-templates_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this power port template.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/dcim/power-ports/": { | |
| "get": { | |
| "operationId": "dcim_power-ports_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "device_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "device", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/PowerPort" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "dcim_power-ports_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritablePowerPort" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritablePowerPort" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/dcim/power-ports/{id}/": { | |
| "get": { | |
| "operationId": "dcim_power-ports_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/PowerPort" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "dcim_power-ports_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritablePowerPort" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritablePowerPort" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "dcim_power-ports_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritablePowerPort" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritablePowerPort" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "dcim_power-ports_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this power port.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/dcim/rack-groups/": { | |
| "get": { | |
| "operationId": "dcim_rack-groups_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "site_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "slug", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "site", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/RackGroup" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "dcim_rack-groups_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableRackGroup" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableRackGroup" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/dcim/rack-groups/{id}/": { | |
| "get": { | |
| "operationId": "dcim_rack-groups_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/RackGroup" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "dcim_rack-groups_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableRackGroup" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableRackGroup" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "dcim_rack-groups_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableRackGroup" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableRackGroup" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "dcim_rack-groups_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this rack group.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/dcim/rack-reservations/": { | |
| "get": { | |
| "operationId": "dcim_rack-reservations_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "created", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "id__in", | |
| "in": "query", | |
| "description": "Multiple values may be separated by commas.", | |
| "required": false, | |
| "type": "number" | |
| }, | |
| { | |
| "name": "q", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "rack_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "site_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "site", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "group_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "group", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "user_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "user", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/RackReservation" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "dcim_rack-reservations_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableRackReservation" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableRackReservation" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/dcim/rack-reservations/{id}/": { | |
| "get": { | |
| "operationId": "dcim_rack-reservations_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/RackReservation" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "dcim_rack-reservations_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableRackReservation" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableRackReservation" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "dcim_rack-reservations_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableRackReservation" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableRackReservation" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "dcim_rack-reservations_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this rack reservation.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/dcim/rack-roles/": { | |
| "get": { | |
| "operationId": "dcim_rack-roles_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "slug", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "color", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/RackRole" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "dcim_rack-roles_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RackRole" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/RackRole" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/dcim/rack-roles/{id}/": { | |
| "get": { | |
| "operationId": "dcim_rack-roles_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/RackRole" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "dcim_rack-roles_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RackRole" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/RackRole" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "dcim_rack-roles_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RackRole" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/RackRole" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "dcim_rack-roles_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this rack role.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/dcim/racks/": { | |
| "get": { | |
| "operationId": "dcim_racks_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "serial", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "type", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "width", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "u_height", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "number" | |
| }, | |
| { | |
| "name": "desc_units", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "id__in", | |
| "in": "query", | |
| "description": "Multiple values may be separated by commas.", | |
| "required": false, | |
| "type": "number" | |
| }, | |
| { | |
| "name": "q", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "facility_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "site_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "site", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "group_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "group", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "tenant_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "tenant", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "role_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "role", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Rack" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "dcim_racks_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableRack" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableRack" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/dcim/racks/{id}/": { | |
| "get": { | |
| "operationId": "dcim_racks_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/Rack" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "dcim_racks_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableRack" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableRack" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "dcim_racks_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableRack" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableRack" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "dcim_racks_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this rack.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/dcim/racks/{id}/units/": { | |
| "get": { | |
| "operationId": "dcim_racks_units", | |
| "description": "List rack units (by rack)", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/Rack" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this rack.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/dcim/regions/": { | |
| "get": { | |
| "operationId": "dcim_regions_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "slug", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "q", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "parent_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "parent", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Region" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "dcim_regions_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableRegion" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableRegion" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/dcim/regions/{id}/": { | |
| "get": { | |
| "operationId": "dcim_regions_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/Region" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "dcim_regions_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableRegion" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableRegion" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "dcim_regions_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableRegion" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableRegion" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "dcim_regions_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this region.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/dcim/sites/": { | |
| "get": { | |
| "operationId": "dcim_sites_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "q", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "slug", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "facility", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "asn", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "number" | |
| }, | |
| { | |
| "name": "contact_name", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "contact_phone", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "contact_email", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "id__in", | |
| "in": "query", | |
| "description": "Multiple values may be separated by commas.", | |
| "required": false, | |
| "type": "number" | |
| }, | |
| { | |
| "name": "region_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "region", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "tenant_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "tenant", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Site" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "dcim_sites_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableSite" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableSite" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/dcim/sites/{id}/": { | |
| "get": { | |
| "operationId": "dcim_sites_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/Site" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "dcim_sites_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableSite" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableSite" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "dcim_sites_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableSite" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableSite" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "dcim_sites_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this site.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/dcim/sites/{id}/graphs/": { | |
| "get": { | |
| "operationId": "dcim_sites_graphs", | |
| "description": "A convenience method for rendering graphs for a particular site.", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/Site" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "dcim" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this site.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/extras/_choices/": { | |
| "get": { | |
| "operationId": "extras__choices_list", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "extras" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/extras/_choices/{id}/": { | |
| "get": { | |
| "operationId": "extras__choices_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "extras" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ] | |
| }, | |
| "/extras/export-templates/": { | |
| "get": { | |
| "operationId": "extras_export-templates_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "content_type", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ExportTemplate" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "extras" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "extras_export-templates_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/ExportTemplate" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/ExportTemplate" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "extras" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/extras/export-templates/{id}/": { | |
| "get": { | |
| "operationId": "extras_export-templates_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/ExportTemplate" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "extras" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "extras_export-templates_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/ExportTemplate" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/ExportTemplate" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "extras" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "extras_export-templates_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/ExportTemplate" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/ExportTemplate" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "extras" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "extras_export-templates_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "extras" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this export template.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/extras/graphs/": { | |
| "get": { | |
| "operationId": "extras_graphs_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "type", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Graph" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "extras" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "extras_graphs_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableGraph" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableGraph" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "extras" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/extras/graphs/{id}/": { | |
| "get": { | |
| "operationId": "extras_graphs_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/Graph" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "extras" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "extras_graphs_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableGraph" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableGraph" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "extras" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "extras_graphs_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableGraph" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableGraph" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "extras" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "extras_graphs_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "extras" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this graph.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/extras/image-attachments/": { | |
| "get": { | |
| "operationId": "extras_image-attachments_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ImageAttachment" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "extras" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "extras_image-attachments_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableImageAttachment" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableImageAttachment" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "extras" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/extras/image-attachments/{id}/": { | |
| "get": { | |
| "operationId": "extras_image-attachments_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/ImageAttachment" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "extras" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "extras_image-attachments_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableImageAttachment" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableImageAttachment" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "extras" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "extras_image-attachments_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableImageAttachment" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableImageAttachment" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "extras" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "extras_image-attachments_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "extras" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this image attachment.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/extras/recent-activity/": { | |
| "get": { | |
| "operationId": "extras_recent-activity_list", | |
| "description": "List all UserActions to provide a log of recent activity.", | |
| "parameters": [ | |
| { | |
| "name": "user", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "username", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/UserAction" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "extras" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/extras/recent-activity/{id}/": { | |
| "get": { | |
| "operationId": "extras_recent-activity_read", | |
| "description": "List all UserActions to provide a log of recent activity.", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/UserAction" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "extras" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this user action.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/extras/topology-maps/": { | |
| "get": { | |
| "operationId": "extras_topology-maps_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "slug", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "site_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "site", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/TopologyMap" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "extras" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "extras_topology-maps_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableTopologyMap" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableTopologyMap" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "extras" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/extras/topology-maps/{id}/": { | |
| "get": { | |
| "operationId": "extras_topology-maps_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/TopologyMap" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "extras" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "extras_topology-maps_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableTopologyMap" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableTopologyMap" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "extras" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "extras_topology-maps_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableTopologyMap" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableTopologyMap" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "extras" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "extras_topology-maps_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "extras" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this topology map.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/extras/topology-maps/{id}/render/": { | |
| "get": { | |
| "operationId": "extras_topology-maps_render", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/TopologyMap" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "extras" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this topology map.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/ipam/_choices/": { | |
| "get": { | |
| "operationId": "ipam__choices_list", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/ipam/_choices/{id}/": { | |
| "get": { | |
| "operationId": "ipam__choices_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ] | |
| }, | |
| "/ipam/aggregates/": { | |
| "get": { | |
| "operationId": "ipam_aggregates_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "family", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "date_added", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "id__in", | |
| "in": "query", | |
| "description": "Multiple values may be separated by commas.", | |
| "required": false, | |
| "type": "number" | |
| }, | |
| { | |
| "name": "q", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "rir_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "rir", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Aggregate" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "ipam_aggregates_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableAggregate" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableAggregate" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/ipam/aggregates/{id}/": { | |
| "get": { | |
| "operationId": "ipam_aggregates_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/Aggregate" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "ipam_aggregates_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableAggregate" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableAggregate" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "ipam_aggregates_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableAggregate" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableAggregate" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "ipam_aggregates_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this aggregate.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/ipam/ip-addresses/": { | |
| "get": { | |
| "operationId": "ipam_ip-addresses_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "family", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "id__in", | |
| "in": "query", | |
| "description": "Multiple values may be separated by commas.", | |
| "required": false, | |
| "type": "number" | |
| }, | |
| { | |
| "name": "q", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "parent", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "mask_length", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "number" | |
| }, | |
| { | |
| "name": "vrf_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "vrf", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "tenant_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "tenant", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "device_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "device", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "virtual_machine_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "virtual_machine", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "interface_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "status", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "role", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/IPAddress" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "ipam_ip-addresses_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableIPAddress" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableIPAddress" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/ipam/ip-addresses/{id}/": { | |
| "get": { | |
| "operationId": "ipam_ip-addresses_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/IPAddress" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "ipam_ip-addresses_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableIPAddress" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableIPAddress" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "ipam_ip-addresses_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableIPAddress" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableIPAddress" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "ipam_ip-addresses_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this IP address.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/ipam/prefixes/": { | |
| "get": { | |
| "operationId": "ipam_prefixes_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "family", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "is_pool", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "id__in", | |
| "in": "query", | |
| "description": "Multiple values may be separated by commas.", | |
| "required": false, | |
| "type": "number" | |
| }, | |
| { | |
| "name": "q", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "parent", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "within", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "within_include", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "contains", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "mask_length", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "number" | |
| }, | |
| { | |
| "name": "vrf_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "vrf", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "tenant_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "tenant", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "site_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "site", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "vlan_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "vlan_vid", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "number" | |
| }, | |
| { | |
| "name": "role_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "role", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "status", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Prefix" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "ipam_prefixes_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritablePrefix" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritablePrefix" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/ipam/prefixes/{id}/": { | |
| "get": { | |
| "operationId": "ipam_prefixes_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/Prefix" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "ipam_prefixes_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritablePrefix" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritablePrefix" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "ipam_prefixes_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritablePrefix" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritablePrefix" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "ipam_prefixes_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this prefix.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/ipam/prefixes/{id}/available-ips/": { | |
| "get": { | |
| "operationId": "ipam_prefixes_available-ips_read", | |
| "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.", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/Prefix" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "ipam_prefixes_available-ips_create", | |
| "description": "A convenience method for returning available IP addresses within a prefix. By default, the number of IPs\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.", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/Prefix" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/Prefix" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this prefix.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/ipam/rirs/": { | |
| "get": { | |
| "operationId": "ipam_rirs_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "slug", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "is_private", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "id__in", | |
| "in": "query", | |
| "description": "Multiple values may be separated by commas.", | |
| "required": false, | |
| "type": "number" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/RIR" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "ipam_rirs_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RIR" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/RIR" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/ipam/rirs/{id}/": { | |
| "get": { | |
| "operationId": "ipam_rirs_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/RIR" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "ipam_rirs_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RIR" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/RIR" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "ipam_rirs_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/RIR" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/RIR" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "ipam_rirs_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this RIR.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/ipam/roles/": { | |
| "get": { | |
| "operationId": "ipam_roles_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "slug", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Role" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "ipam_roles_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/Role" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/Role" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/ipam/roles/{id}/": { | |
| "get": { | |
| "operationId": "ipam_roles_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/Role" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "ipam_roles_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/Role" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/Role" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "ipam_roles_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/Role" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/Role" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "ipam_roles_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this role.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/ipam/services/": { | |
| "get": { | |
| "operationId": "ipam_services_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "protocol", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "port", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "number" | |
| }, | |
| { | |
| "name": "device_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "device", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "virtual_machine_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "virtual_machine", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Service" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "ipam_services_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableService" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableService" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/ipam/services/{id}/": { | |
| "get": { | |
| "operationId": "ipam_services_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/Service" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "ipam_services_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableService" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableService" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "ipam_services_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableService" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableService" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "ipam_services_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this service.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/ipam/vlan-groups/": { | |
| "get": { | |
| "operationId": "ipam_vlan-groups_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "slug", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "site_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "site", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/VLANGroup" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "ipam_vlan-groups_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableVLANGroup" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableVLANGroup" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/ipam/vlan-groups/{id}/": { | |
| "get": { | |
| "operationId": "ipam_vlan-groups_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/VLANGroup" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "ipam_vlan-groups_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableVLANGroup" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableVLANGroup" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "ipam_vlan-groups_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableVLANGroup" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableVLANGroup" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "ipam_vlan-groups_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this VLAN group.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/ipam/vlans/": { | |
| "get": { | |
| "operationId": "ipam_vlans_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "vid", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "number" | |
| }, | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "id__in", | |
| "in": "query", | |
| "description": "Multiple values may be separated by commas.", | |
| "required": false, | |
| "type": "number" | |
| }, | |
| { | |
| "name": "q", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "site_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "site", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "group_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "group", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "tenant_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "tenant", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "role_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "role", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "status", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/VLAN" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "ipam_vlans_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableVLAN" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableVLAN" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/ipam/vlans/{id}/": { | |
| "get": { | |
| "operationId": "ipam_vlans_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/VLAN" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "ipam_vlans_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableVLAN" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableVLAN" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "ipam_vlans_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableVLAN" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableVLAN" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "ipam_vlans_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this VLAN.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/ipam/vrfs/": { | |
| "get": { | |
| "operationId": "ipam_vrfs_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "rd", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "enforce_unique", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "id__in", | |
| "in": "query", | |
| "description": "Multiple values may be separated by commas.", | |
| "required": false, | |
| "type": "number" | |
| }, | |
| { | |
| "name": "q", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "tenant_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "tenant", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/VRF" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "ipam_vrfs_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableVRF" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableVRF" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/ipam/vrfs/{id}/": { | |
| "get": { | |
| "operationId": "ipam_vrfs_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/VRF" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "ipam_vrfs_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableVRF" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableVRF" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "ipam_vrfs_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableVRF" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableVRF" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "ipam_vrfs_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "ipam" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this VRF.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/secrets/_choices/": { | |
| "get": { | |
| "operationId": "secrets__choices_list", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "secrets" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/secrets/_choices/{id}/": { | |
| "get": { | |
| "operationId": "secrets__choices_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "secrets" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ] | |
| }, | |
| "/secrets/generate-rsa-key-pair/": { | |
| "get": { | |
| "operationId": "secrets_generate-rsa-key-pair_list", | |
| "description": "This endpoint can be used to generate a new RSA key pair. The keys are returned in PEM format.\n\n {\n \"public_key\": \"<public key>\",\n \"private_key\": \"<private key>\"\n }", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "secrets" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/secrets/get-session-key/": { | |
| "post": { | |
| "operationId": "secrets_get-session-key_create", | |
| "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.", | |
| "parameters": [], | |
| "responses": { | |
| "201": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "secrets" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/secrets/secret-roles/": { | |
| "get": { | |
| "operationId": "secrets_secret-roles_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "slug", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/SecretRole" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "secrets" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "secrets_secret-roles_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/SecretRole" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/SecretRole" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "secrets" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/secrets/secret-roles/{id}/": { | |
| "get": { | |
| "operationId": "secrets_secret-roles_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/SecretRole" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "secrets" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "secrets_secret-roles_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/SecretRole" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/SecretRole" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "secrets" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "secrets_secret-roles_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/SecretRole" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/SecretRole" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "secrets" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "secrets_secret-roles_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "secrets" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this secret role.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/secrets/secrets/": { | |
| "get": { | |
| "operationId": "secrets_secrets_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "id__in", | |
| "in": "query", | |
| "description": "Multiple values may be separated by commas.", | |
| "required": false, | |
| "type": "number" | |
| }, | |
| { | |
| "name": "q", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "role_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "role", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "device_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "device", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Secret" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "secrets" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "secrets_secrets_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableSecret" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableSecret" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "secrets" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/secrets/secrets/{id}/": { | |
| "get": { | |
| "operationId": "secrets_secrets_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/Secret" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "secrets" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "secrets_secrets_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableSecret" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableSecret" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "secrets" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "secrets_secrets_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableSecret" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableSecret" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "secrets" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "secrets_secrets_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "secrets" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this secret.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/tenancy/_choices/": { | |
| "get": { | |
| "operationId": "tenancy__choices_list", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "tenancy" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/tenancy/_choices/{id}/": { | |
| "get": { | |
| "operationId": "tenancy__choices_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "tenancy" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ] | |
| }, | |
| "/tenancy/tenant-groups/": { | |
| "get": { | |
| "operationId": "tenancy_tenant-groups_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "slug", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/TenantGroup" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "tenancy" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "tenancy_tenant-groups_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/TenantGroup" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/TenantGroup" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "tenancy" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/tenancy/tenant-groups/{id}/": { | |
| "get": { | |
| "operationId": "tenancy_tenant-groups_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/TenantGroup" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "tenancy" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "tenancy_tenant-groups_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/TenantGroup" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/TenantGroup" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "tenancy" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "tenancy_tenant-groups_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/TenantGroup" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/TenantGroup" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "tenancy" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "tenancy_tenant-groups_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "tenancy" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this tenant group.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/tenancy/tenants/": { | |
| "get": { | |
| "operationId": "tenancy_tenants_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "id__in", | |
| "in": "query", | |
| "description": "Multiple values may be separated by commas.", | |
| "required": false, | |
| "type": "number" | |
| }, | |
| { | |
| "name": "q", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "group_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "group", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Tenant" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "tenancy" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "tenancy_tenants_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableTenant" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableTenant" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "tenancy" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/tenancy/tenants/{id}/": { | |
| "get": { | |
| "operationId": "tenancy_tenants_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/Tenant" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "tenancy" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "tenancy_tenants_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableTenant" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableTenant" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "tenancy" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "tenancy_tenants_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableTenant" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableTenant" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "tenancy" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "tenancy_tenants_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "tenancy" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this tenant.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/virtualization/_choices/": { | |
| "get": { | |
| "operationId": "virtualization__choices_list", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "virtualization" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/virtualization/_choices/{id}/": { | |
| "get": { | |
| "operationId": "virtualization__choices_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "virtualization" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ] | |
| }, | |
| "/virtualization/cluster-groups/": { | |
| "get": { | |
| "operationId": "virtualization_cluster-groups_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ClusterGroup" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "virtualization" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "virtualization_cluster-groups_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/ClusterGroup" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/ClusterGroup" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "virtualization" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/virtualization/cluster-groups/{id}/": { | |
| "get": { | |
| "operationId": "virtualization_cluster-groups_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/ClusterGroup" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "virtualization" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "virtualization_cluster-groups_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/ClusterGroup" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/ClusterGroup" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "virtualization" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "virtualization_cluster-groups_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/ClusterGroup" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/ClusterGroup" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "virtualization" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "virtualization_cluster-groups_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "virtualization" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this cluster group.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/virtualization/cluster-types/": { | |
| "get": { | |
| "operationId": "virtualization_cluster-types_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ClusterType" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "virtualization" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "virtualization_cluster-types_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/ClusterType" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/ClusterType" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "virtualization" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/virtualization/cluster-types/{id}/": { | |
| "get": { | |
| "operationId": "virtualization_cluster-types_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/ClusterType" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "virtualization" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "virtualization_cluster-types_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/ClusterType" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/ClusterType" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "virtualization" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "virtualization_cluster-types_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/ClusterType" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/ClusterType" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "virtualization" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "virtualization_cluster-types_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "virtualization" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this cluster type.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/virtualization/clusters/": { | |
| "get": { | |
| "operationId": "virtualization_clusters_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "id__in", | |
| "in": "query", | |
| "description": "Multiple values may be separated by commas.", | |
| "required": false, | |
| "type": "number" | |
| }, | |
| { | |
| "name": "q", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "group_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "group", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "type_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "type", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "site_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "site", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Cluster" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "virtualization" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "virtualization_clusters_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableCluster" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableCluster" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "virtualization" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/virtualization/clusters/{id}/": { | |
| "get": { | |
| "operationId": "virtualization_clusters_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/Cluster" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "virtualization" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "virtualization_clusters_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableCluster" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableCluster" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "virtualization" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "virtualization_clusters_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableCluster" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableCluster" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "virtualization" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "virtualization_clusters_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "virtualization" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this cluster.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/virtualization/interfaces/": { | |
| "get": { | |
| "operationId": "virtualization_interfaces_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "enabled", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "mtu", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "number" | |
| }, | |
| { | |
| "name": "virtual_machine_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "virtual_machine", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "mac_address", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Interface" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "virtualization" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "virtualization_interfaces_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableInterface" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableInterface" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "virtualization" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/virtualization/interfaces/{id}/": { | |
| "get": { | |
| "operationId": "virtualization_interfaces_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/Interface" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "virtualization" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "virtualization_interfaces_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableInterface" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableInterface" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "virtualization" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "virtualization_interfaces_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableInterface" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableInterface" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "virtualization" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "virtualization_interfaces_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "virtualization" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this interface.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| }, | |
| "/virtualization/virtual-machines/": { | |
| "get": { | |
| "operationId": "virtualization_virtual-machines_list", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "cluster", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "id__in", | |
| "in": "query", | |
| "description": "Multiple values may be separated by commas.", | |
| "required": false, | |
| "type": "number" | |
| }, | |
| { | |
| "name": "q", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "status", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "cluster_group_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "cluster_group", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "cluster_type_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "cluster_type", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "cluster_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "site_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "site", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "role_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "role", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "tenant_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "tenant", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "platform_id", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "platform", | |
| "in": "query", | |
| "description": "", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "description": "Number of results to return per page.", | |
| "required": false, | |
| "type": "integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "description": "The initial index from which to return the results.", | |
| "required": false, | |
| "type": "integer" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "required": [ | |
| "count", | |
| "results" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "next": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "previous": { | |
| "type": "string", | |
| "format": "uri" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/VirtualMachine" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "virtualization" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "virtualization_virtual-machines_create", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableVirtualMachine" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableVirtualMachine" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "virtualization" | |
| ] | |
| }, | |
| "parameters": [] | |
| }, | |
| "/virtualization/virtual-machines/{id}/": { | |
| "get": { | |
| "operationId": "virtualization_virtual-machines_read", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/VirtualMachine" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "virtualization" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "virtualization_virtual-machines_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableVirtualMachine" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableVirtualMachine" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "virtualization" | |
| ] | |
| }, | |
| "patch": { | |
| "operationId": "virtualization_virtual-machines_partial_update", | |
| "description": "", | |
| "parameters": [ | |
| { | |
| "name": "data", | |
| "in": "body", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/WritableVirtualMachine" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WritableVirtualMachine" | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| "virtualization" | |
| ] | |
| }, | |
| "delete": { | |
| "operationId": "virtualization_virtual-machines_delete", | |
| "description": "", | |
| "parameters": [], | |
| "responses": { | |
| "204": { | |
| "description": "" | |
| } | |
| }, | |
| "tags": [ | |
| "virtualization" | |
| ] | |
| }, | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "A unique integer value identifying this virtual machine.", | |
| "required": true, | |
| "type": "integer" | |
| } | |
| ] | |
| } | |
| }, | |
| "definitions": { | |
| "NestedCircuit": { | |
| "title": "Circuit", | |
| "required": [ | |
| "cid" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "url": { | |
| "title": "Url", | |
| "type": "string", | |
| "format": "uri", | |
| "readOnly": true | |
| }, | |
| "cid": { | |
| "title": "Circuit ID", | |
| "type": "string", | |
| "maxLength": 50 | |
| } | |
| } | |
| }, | |
| "NestedSite": { | |
| "title": "Site", | |
| "required": [ | |
| "name", | |
| "slug" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "url": { | |
| "title": "Url", | |
| "type": "string", | |
| "format": "uri", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "slug": { | |
| "title": "Slug", | |
| "type": "string", | |
| "format": "slug", | |
| "pattern": "^[-a-zA-Z0-9_]+$", | |
| "maxLength": 50 | |
| } | |
| } | |
| }, | |
| "NestedDevice": { | |
| "title": "Device", | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "url": { | |
| "title": "Url", | |
| "type": "string", | |
| "format": "uri", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 64 | |
| }, | |
| "display_name": { | |
| "title": "Display name", | |
| "type": "string", | |
| "readOnly": true | |
| } | |
| } | |
| }, | |
| "NestedInterface": { | |
| "title": "Lag", | |
| "required": [ | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "url": { | |
| "title": "Url", | |
| "type": "string", | |
| "format": "uri", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 64 | |
| } | |
| } | |
| }, | |
| "InterfaceNestedCircuit": { | |
| "title": "Circuit", | |
| "required": [ | |
| "cid" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "url": { | |
| "title": "Url", | |
| "type": "string", | |
| "format": "uri", | |
| "readOnly": true | |
| }, | |
| "cid": { | |
| "title": "Circuit ID", | |
| "type": "string", | |
| "maxLength": 50 | |
| } | |
| } | |
| }, | |
| "InterfaceCircuitTermination": { | |
| "title": "Circuit termination", | |
| "required": [ | |
| "circuit", | |
| "term_side", | |
| "port_speed" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "circuit": { | |
| "$ref": "#/definitions/InterfaceNestedCircuit" | |
| }, | |
| "term_side": { | |
| "title": "Termination", | |
| "type": "string", | |
| "enum": [ | |
| "A", | |
| "Z" | |
| ] | |
| }, | |
| "port_speed": { | |
| "title": "Port speed (Kbps)", | |
| "type": "integer", | |
| "maximum": 2147483647, | |
| "minimum": 0 | |
| }, | |
| "upstream_speed": { | |
| "title": "Upstream speed (Kbps)", | |
| "description": "Upstream speed, if different from port speed", | |
| "type": "integer", | |
| "maximum": 2147483647, | |
| "minimum": 0 | |
| }, | |
| "xconnect_id": { | |
| "title": "Cross-connect ID", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "pp_info": { | |
| "title": "Patch panel/port(s)", | |
| "type": "string", | |
| "maxLength": 100 | |
| } | |
| } | |
| }, | |
| "Interface": { | |
| "title": "Interface", | |
| "required": [ | |
| "device", | |
| "name", | |
| "form_factor", | |
| "lag", | |
| "circuit_termination" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "device": { | |
| "$ref": "#/definitions/NestedDevice" | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 64 | |
| }, | |
| "form_factor": { | |
| "title": "Form factor", | |
| "type": "string" | |
| }, | |
| "enabled": { | |
| "title": "Enabled", | |
| "type": "boolean" | |
| }, | |
| "lag": { | |
| "$ref": "#/definitions/NestedInterface" | |
| }, | |
| "mtu": { | |
| "title": "MTU", | |
| "type": "integer", | |
| "maximum": 32767, | |
| "minimum": 0 | |
| }, | |
| "mac_address": { | |
| "title": "MAC Address", | |
| "type": "string" | |
| }, | |
| "mgmt_only": { | |
| "title": "OOB Management", | |
| "description": "This interface is used only for out-of-band management", | |
| "type": "boolean" | |
| }, | |
| "description": { | |
| "title": "Description", | |
| "type": "string", | |
| "maxLength": 100 | |
| }, | |
| "is_connected": { | |
| "title": "Is connected", | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "interface_connection": { | |
| "title": "Interface connection", | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "circuit_termination": { | |
| "$ref": "#/definitions/InterfaceCircuitTermination" | |
| } | |
| } | |
| }, | |
| "CircuitTermination": { | |
| "required": [ | |
| "circuit", | |
| "term_side", | |
| "site", | |
| "interface", | |
| "port_speed" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "circuit": { | |
| "$ref": "#/definitions/NestedCircuit" | |
| }, | |
| "term_side": { | |
| "title": "Termination", | |
| "type": "string", | |
| "enum": [ | |
| "A", | |
| "Z" | |
| ] | |
| }, | |
| "site": { | |
| "$ref": "#/definitions/NestedSite" | |
| }, | |
| "interface": { | |
| "$ref": "#/definitions/Interface" | |
| }, | |
| "port_speed": { | |
| "title": "Port speed (Kbps)", | |
| "type": "integer", | |
| "maximum": 2147483647, | |
| "minimum": 0 | |
| }, | |
| "upstream_speed": { | |
| "title": "Upstream speed (Kbps)", | |
| "description": "Upstream speed, if different from port speed", | |
| "type": "integer", | |
| "maximum": 2147483647, | |
| "minimum": 0 | |
| }, | |
| "xconnect_id": { | |
| "title": "Cross-connect ID", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "pp_info": { | |
| "title": "Patch panel/port(s)", | |
| "type": "string", | |
| "maxLength": 100 | |
| } | |
| } | |
| }, | |
| "WritableCircuitTermination": { | |
| "required": [ | |
| "circuit", | |
| "term_side", | |
| "site", | |
| "port_speed" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "circuit": { | |
| "title": "Circuit", | |
| "type": "integer" | |
| }, | |
| "term_side": { | |
| "title": "Termination", | |
| "type": "string", | |
| "enum": [ | |
| "A", | |
| "Z" | |
| ] | |
| }, | |
| "site": { | |
| "title": "Site", | |
| "type": "integer" | |
| }, | |
| "interface": { | |
| "title": "Interface", | |
| "type": "integer" | |
| }, | |
| "port_speed": { | |
| "title": "Port speed (Kbps)", | |
| "type": "integer", | |
| "maximum": 2147483647, | |
| "minimum": 0 | |
| }, | |
| "upstream_speed": { | |
| "title": "Upstream speed (Kbps)", | |
| "description": "Upstream speed, if different from port speed", | |
| "type": "integer", | |
| "maximum": 2147483647, | |
| "minimum": 0 | |
| }, | |
| "xconnect_id": { | |
| "title": "Cross-connect ID", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "pp_info": { | |
| "title": "Patch panel/port(s)", | |
| "type": "string", | |
| "maxLength": 100 | |
| } | |
| } | |
| }, | |
| "CircuitType": { | |
| "required": [ | |
| "name", | |
| "slug" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "slug": { | |
| "title": "Slug", | |
| "type": "string", | |
| "format": "slug", | |
| "pattern": "^[-a-zA-Z0-9_]+$", | |
| "maxLength": 50 | |
| } | |
| } | |
| }, | |
| "NestedProvider": { | |
| "title": "Provider", | |
| "required": [ | |
| "name", | |
| "slug" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "url": { | |
| "title": "Url", | |
| "type": "string", | |
| "format": "uri", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "slug": { | |
| "title": "Slug", | |
| "type": "string", | |
| "format": "slug", | |
| "pattern": "^[-a-zA-Z0-9_]+$", | |
| "maxLength": 50 | |
| } | |
| } | |
| }, | |
| "NestedCircuitType": { | |
| "title": "Type", | |
| "required": [ | |
| "name", | |
| "slug" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "url": { | |
| "title": "Url", | |
| "type": "string", | |
| "format": "uri", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "slug": { | |
| "title": "Slug", | |
| "type": "string", | |
| "format": "slug", | |
| "pattern": "^[-a-zA-Z0-9_]+$", | |
| "maxLength": 50 | |
| } | |
| } | |
| }, | |
| "NestedTenant": { | |
| "title": "Tenant", | |
| "required": [ | |
| "name", | |
| "slug" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "url": { | |
| "title": "Url", | |
| "type": "string", | |
| "format": "uri", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 30 | |
| }, | |
| "slug": { | |
| "title": "Slug", | |
| "type": "string", | |
| "format": "slug", | |
| "pattern": "^[-a-zA-Z0-9_]+$", | |
| "maxLength": 50 | |
| } | |
| } | |
| }, | |
| "Circuit": { | |
| "required": [ | |
| "cid", | |
| "provider", | |
| "type", | |
| "tenant" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "cid": { | |
| "title": "Circuit ID", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "provider": { | |
| "$ref": "#/definitions/NestedProvider" | |
| }, | |
| "type": { | |
| "$ref": "#/definitions/NestedCircuitType" | |
| }, | |
| "tenant": { | |
| "$ref": "#/definitions/NestedTenant" | |
| }, | |
| "install_date": { | |
| "title": "Date installed", | |
| "type": "string", | |
| "format": "date" | |
| }, | |
| "commit_rate": { | |
| "title": "Commit rate (Kbps)", | |
| "type": "integer", | |
| "maximum": 2147483647, | |
| "minimum": 0 | |
| }, | |
| "description": { | |
| "title": "Description", | |
| "type": "string", | |
| "maxLength": 100 | |
| }, | |
| "comments": { | |
| "title": "Comments", | |
| "type": "string" | |
| }, | |
| "custom_fields": { | |
| "title": "Custom fields", | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "WritableCircuit": { | |
| "required": [ | |
| "cid", | |
| "provider", | |
| "type" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "cid": { | |
| "title": "Circuit ID", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "provider": { | |
| "title": "Provider", | |
| "type": "integer" | |
| }, | |
| "type": { | |
| "title": "Type", | |
| "type": "integer" | |
| }, | |
| "tenant": { | |
| "title": "Tenant", | |
| "type": "integer" | |
| }, | |
| "install_date": { | |
| "title": "Date installed", | |
| "type": "string", | |
| "format": "date" | |
| }, | |
| "commit_rate": { | |
| "title": "Commit rate (Kbps)", | |
| "type": "integer", | |
| "maximum": 2147483647, | |
| "minimum": 0 | |
| }, | |
| "description": { | |
| "title": "Description", | |
| "type": "string", | |
| "maxLength": 100 | |
| }, | |
| "comments": { | |
| "title": "Comments", | |
| "type": "string" | |
| }, | |
| "custom_fields": { | |
| "title": "Custom fields", | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "Provider": { | |
| "required": [ | |
| "name", | |
| "slug" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "slug": { | |
| "title": "Slug", | |
| "type": "string", | |
| "format": "slug", | |
| "pattern": "^[-a-zA-Z0-9_]+$", | |
| "maxLength": 50 | |
| }, | |
| "asn": { | |
| "title": "ASN", | |
| "type": "integer", | |
| "maximum": 4294967295, | |
| "minimum": 1 | |
| }, | |
| "account": { | |
| "title": "Account number", | |
| "type": "string", | |
| "maxLength": 30 | |
| }, | |
| "portal_url": { | |
| "title": "Portal", | |
| "type": "string", | |
| "format": "uri", | |
| "maxLength": 200 | |
| }, | |
| "noc_contact": { | |
| "title": "NOC contact", | |
| "type": "string" | |
| }, | |
| "admin_contact": { | |
| "title": "Admin contact", | |
| "type": "string" | |
| }, | |
| "comments": { | |
| "title": "Comments", | |
| "type": "string" | |
| }, | |
| "custom_fields": { | |
| "title": "Custom fields", | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "WritableProvider": { | |
| "required": [ | |
| "name", | |
| "slug" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "slug": { | |
| "title": "Slug", | |
| "type": "string", | |
| "format": "slug", | |
| "pattern": "^[-a-zA-Z0-9_]+$", | |
| "maxLength": 50 | |
| }, | |
| "asn": { | |
| "title": "ASN", | |
| "type": "integer", | |
| "maximum": 4294967295, | |
| "minimum": 1 | |
| }, | |
| "account": { | |
| "title": "Account number", | |
| "type": "string", | |
| "maxLength": 30 | |
| }, | |
| "portal_url": { | |
| "title": "Portal", | |
| "type": "string", | |
| "format": "uri", | |
| "maxLength": 200 | |
| }, | |
| "noc_contact": { | |
| "title": "NOC contact", | |
| "type": "string" | |
| }, | |
| "admin_contact": { | |
| "title": "Admin contact", | |
| "type": "string" | |
| }, | |
| "comments": { | |
| "title": "Comments", | |
| "type": "string" | |
| }, | |
| "custom_fields": { | |
| "title": "Custom fields", | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "ConsoleServerPort": { | |
| "title": "Cs port", | |
| "required": [ | |
| "device", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "device": { | |
| "$ref": "#/definitions/NestedDevice" | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "connected_console": { | |
| "title": "Connected console", | |
| "type": "string", | |
| "readOnly": true | |
| } | |
| } | |
| }, | |
| "ConsolePort": { | |
| "required": [ | |
| "device", | |
| "name", | |
| "cs_port" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "device": { | |
| "$ref": "#/definitions/NestedDevice" | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "cs_port": { | |
| "$ref": "#/definitions/ConsoleServerPort" | |
| }, | |
| "connection_status": { | |
| "title": "Connection status", | |
| "type": "string", | |
| "enum": [ | |
| false, | |
| true | |
| ] | |
| } | |
| } | |
| }, | |
| "NestedManufacturer": { | |
| "title": "Manufacturer", | |
| "required": [ | |
| "name", | |
| "slug" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "url": { | |
| "title": "Url", | |
| "type": "string", | |
| "format": "uri", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "slug": { | |
| "title": "Slug", | |
| "type": "string", | |
| "format": "slug", | |
| "pattern": "^[-a-zA-Z0-9_]+$", | |
| "maxLength": 50 | |
| } | |
| } | |
| }, | |
| "NestedDeviceType": { | |
| "title": "Device type", | |
| "required": [ | |
| "manufacturer", | |
| "model", | |
| "slug" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "url": { | |
| "title": "Url", | |
| "type": "string", | |
| "format": "uri", | |
| "readOnly": true | |
| }, | |
| "manufacturer": { | |
| "$ref": "#/definitions/NestedManufacturer" | |
| }, | |
| "model": { | |
| "title": "Model", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "slug": { | |
| "title": "Slug", | |
| "type": "string", | |
| "format": "slug", | |
| "pattern": "^[-a-zA-Z0-9_]+$", | |
| "maxLength": 50 | |
| } | |
| } | |
| }, | |
| "ConsolePortTemplate": { | |
| "required": [ | |
| "device_type", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "device_type": { | |
| "$ref": "#/definitions/NestedDeviceType" | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| } | |
| } | |
| }, | |
| "WritableConsolePortTemplate": { | |
| "required": [ | |
| "device_type", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "device_type": { | |
| "title": "Device type", | |
| "type": "integer" | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| } | |
| } | |
| }, | |
| "WritableConsolePort": { | |
| "required": [ | |
| "device", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "device": { | |
| "title": "Device", | |
| "type": "integer" | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "cs_port": { | |
| "title": "Console server port", | |
| "type": "integer" | |
| }, | |
| "connection_status": { | |
| "title": "Connection status", | |
| "type": "string", | |
| "enum": [ | |
| false, | |
| true | |
| ] | |
| } | |
| } | |
| }, | |
| "ConsoleServerPortTemplate": { | |
| "required": [ | |
| "device_type", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "device_type": { | |
| "$ref": "#/definitions/NestedDeviceType" | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| } | |
| } | |
| }, | |
| "WritableConsoleServerPortTemplate": { | |
| "required": [ | |
| "device_type", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "device_type": { | |
| "title": "Device type", | |
| "type": "integer" | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| } | |
| } | |
| }, | |
| "WritableConsoleServerPort": { | |
| "required": [ | |
| "device", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "device": { | |
| "title": "Device", | |
| "type": "integer" | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| } | |
| } | |
| }, | |
| "DeviceBayTemplate": { | |
| "required": [ | |
| "device_type", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "device_type": { | |
| "$ref": "#/definitions/NestedDeviceType" | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| } | |
| } | |
| }, | |
| "WritableDeviceBayTemplate": { | |
| "required": [ | |
| "device_type", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "device_type": { | |
| "title": "Device type", | |
| "type": "integer" | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| } | |
| } | |
| }, | |
| "DeviceBay": { | |
| "required": [ | |
| "device", | |
| "name", | |
| "installed_device" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "device": { | |
| "$ref": "#/definitions/NestedDevice" | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "installed_device": { | |
| "$ref": "#/definitions/NestedDevice" | |
| } | |
| } | |
| }, | |
| "WritableDeviceBay": { | |
| "required": [ | |
| "device", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "device": { | |
| "title": "Device", | |
| "type": "integer" | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "installed_device": { | |
| "title": "Installed device", | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "DeviceRole": { | |
| "required": [ | |
| "name", | |
| "slug", | |
| "color" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "slug": { | |
| "title": "Slug", | |
| "type": "string", | |
| "format": "slug", | |
| "pattern": "^[-a-zA-Z0-9_]+$", | |
| "maxLength": 50 | |
| }, | |
| "color": { | |
| "title": "Color", | |
| "type": "string", | |
| "pattern": "^[0-9a-f]{6}$", | |
| "maxLength": 6 | |
| }, | |
| "vm_role": { | |
| "title": "VM Role", | |
| "description": "Virtual machines may be assigned to this role", | |
| "type": "boolean" | |
| } | |
| } | |
| }, | |
| "DeviceType": { | |
| "required": [ | |
| "manufacturer", | |
| "model", | |
| "slug", | |
| "interface_ordering", | |
| "subdevice_role" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "manufacturer": { | |
| "$ref": "#/definitions/NestedManufacturer" | |
| }, | |
| "model": { | |
| "title": "Model", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "slug": { | |
| "title": "Slug", | |
| "type": "string", | |
| "format": "slug", | |
| "pattern": "^[-a-zA-Z0-9_]+$", | |
| "maxLength": 50 | |
| }, | |
| "part_number": { | |
| "title": "Part number", | |
| "description": "Discrete part number (optional)", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "u_height": { | |
| "title": "Height (U)", | |
| "type": "integer", | |
| "maximum": 32767, | |
| "minimum": 0 | |
| }, | |
| "is_full_depth": { | |
| "title": "Is full depth", | |
| "description": "Device consumes both front and rear rack faces", | |
| "type": "boolean" | |
| }, | |
| "interface_ordering": { | |
| "title": "Interface ordering", | |
| "type": "string" | |
| }, | |
| "is_console_server": { | |
| "title": "Is a console server", | |
| "description": "This type of device has console server ports", | |
| "type": "boolean" | |
| }, | |
| "is_pdu": { | |
| "title": "Is a PDU", | |
| "description": "This type of device has power outlets", | |
| "type": "boolean" | |
| }, | |
| "is_network_device": { | |
| "title": "Is a network device", | |
| "description": "This type of device has network interfaces", | |
| "type": "boolean" | |
| }, | |
| "subdevice_role": { | |
| "title": "Subdevice role", | |
| "type": "string" | |
| }, | |
| "comments": { | |
| "title": "Comments", | |
| "type": "string" | |
| }, | |
| "custom_fields": { | |
| "title": "Custom fields", | |
| "type": "string" | |
| }, | |
| "instance_count": { | |
| "title": "Instance count", | |
| "type": "integer", | |
| "readOnly": true | |
| } | |
| } | |
| }, | |
| "WritableDeviceType": { | |
| "required": [ | |
| "manufacturer", | |
| "model", | |
| "slug" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "manufacturer": { | |
| "title": "Manufacturer", | |
| "type": "integer" | |
| }, | |
| "model": { | |
| "title": "Model", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "slug": { | |
| "title": "Slug", | |
| "type": "string", | |
| "format": "slug", | |
| "pattern": "^[-a-zA-Z0-9_]+$", | |
| "maxLength": 50 | |
| }, | |
| "part_number": { | |
| "title": "Part number", | |
| "description": "Discrete part number (optional)", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "u_height": { | |
| "title": "Height (U)", | |
| "type": "integer", | |
| "maximum": 32767, | |
| "minimum": 0 | |
| }, | |
| "is_full_depth": { | |
| "title": "Is full depth", | |
| "description": "Device consumes both front and rear rack faces", | |
| "type": "boolean" | |
| }, | |
| "interface_ordering": { | |
| "title": "Interface ordering", | |
| "type": "string", | |
| "enum": [ | |
| 1, | |
| 2 | |
| ] | |
| }, | |
| "is_console_server": { | |
| "title": "Is a console server", | |
| "description": "This type of device has console server ports", | |
| "type": "boolean" | |
| }, | |
| "is_pdu": { | |
| "title": "Is a PDU", | |
| "description": "This type of device has power outlets", | |
| "type": "boolean" | |
| }, | |
| "is_network_device": { | |
| "title": "Is a network device", | |
| "description": "This type of device has network interfaces", | |
| "type": "boolean" | |
| }, | |
| "subdevice_role": { | |
| "title": "Parent/child status", | |
| "description": "Parent devices house child devices in device bays. Select \"None\" if this device type is neither a parent nor a child.", | |
| "type": "string", | |
| "enum": [ | |
| null, | |
| true, | |
| false | |
| ] | |
| }, | |
| "comments": { | |
| "title": "Comments", | |
| "type": "string" | |
| }, | |
| "custom_fields": { | |
| "title": "Custom fields", | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "NestedDeviceRole": { | |
| "title": "Device role", | |
| "required": [ | |
| "name", | |
| "slug" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "url": { | |
| "title": "Url", | |
| "type": "string", | |
| "format": "uri", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "slug": { | |
| "title": "Slug", | |
| "type": "string", | |
| "format": "slug", | |
| "pattern": "^[-a-zA-Z0-9_]+$", | |
| "maxLength": 50 | |
| } | |
| } | |
| }, | |
| "NestedPlatform": { | |
| "title": "Platform", | |
| "required": [ | |
| "name", | |
| "slug" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "url": { | |
| "title": "Url", | |
| "type": "string", | |
| "format": "uri", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "slug": { | |
| "title": "Slug", | |
| "type": "string", | |
| "format": "slug", | |
| "pattern": "^[-a-zA-Z0-9_]+$", | |
| "maxLength": 50 | |
| } | |
| } | |
| }, | |
| "NestedRack": { | |
| "title": "Rack", | |
| "required": [ | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "url": { | |
| "title": "Url", | |
| "type": "string", | |
| "format": "uri", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "display_name": { | |
| "title": "Display name", | |
| "type": "string", | |
| "readOnly": true | |
| } | |
| } | |
| }, | |
| "DeviceIPAddress": { | |
| "title": "Primary ip", | |
| "required": [ | |
| "address" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "url": { | |
| "title": "Url", | |
| "type": "string", | |
| "format": "uri", | |
| "readOnly": true | |
| }, | |
| "family": { | |
| "title": "Family", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "address": { | |
| "title": "Address", | |
| "description": "IPv4 or IPv6 address (with mask)", | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "NestedCluster": { | |
| "title": "Cluster", | |
| "required": [ | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "url": { | |
| "title": "Url", | |
| "type": "string", | |
| "format": "uri", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 100 | |
| } | |
| } | |
| }, | |
| "Device": { | |
| "required": [ | |
| "device_type", | |
| "device_role", | |
| "tenant", | |
| "platform", | |
| "site", | |
| "rack", | |
| "position", | |
| "face", | |
| "status", | |
| "primary_ip", | |
| "primary_ip4", | |
| "primary_ip6", | |
| "cluster" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 64 | |
| }, | |
| "display_name": { | |
| "title": "Display name", | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "device_type": { | |
| "$ref": "#/definitions/NestedDeviceType" | |
| }, | |
| "device_role": { | |
| "$ref": "#/definitions/NestedDeviceRole" | |
| }, | |
| "tenant": { | |
| "$ref": "#/definitions/NestedTenant" | |
| }, | |
| "platform": { | |
| "$ref": "#/definitions/NestedPlatform" | |
| }, | |
| "serial": { | |
| "title": "Serial number", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "asset_tag": { | |
| "title": "Asset tag", | |
| "description": "A unique tag used to identify this device", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "site": { | |
| "$ref": "#/definitions/NestedSite" | |
| }, | |
| "rack": { | |
| "$ref": "#/definitions/NestedRack" | |
| }, | |
| "position": { | |
| "title": "Position (U)", | |
| "description": "The lowest-numbered unit occupied by the device", | |
| "type": "integer", | |
| "maximum": 32767, | |
| "minimum": 1 | |
| }, | |
| "face": { | |
| "title": "Face", | |
| "type": "string" | |
| }, | |
| "parent_device": { | |
| "title": "Parent device", | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "status": { | |
| "title": "Status", | |
| "type": "string" | |
| }, | |
| "primary_ip": { | |
| "$ref": "#/definitions/DeviceIPAddress" | |
| }, | |
| "primary_ip4": { | |
| "$ref": "#/definitions/DeviceIPAddress" | |
| }, | |
| "primary_ip6": { | |
| "$ref": "#/definitions/DeviceIPAddress" | |
| }, | |
| "cluster": { | |
| "$ref": "#/definitions/NestedCluster" | |
| }, | |
| "comments": { | |
| "title": "Comments", | |
| "type": "string" | |
| }, | |
| "custom_fields": { | |
| "title": "Custom fields", | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "WritableDevice": { | |
| "required": [ | |
| "device_type", | |
| "device_role", | |
| "site" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 64 | |
| }, | |
| "device_type": { | |
| "title": "Device type", | |
| "type": "integer" | |
| }, | |
| "device_role": { | |
| "title": "Device role", | |
| "type": "integer" | |
| }, | |
| "tenant": { | |
| "title": "Tenant", | |
| "type": "integer" | |
| }, | |
| "platform": { | |
| "title": "Platform", | |
| "type": "integer" | |
| }, | |
| "serial": { | |
| "title": "Serial number", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "asset_tag": { | |
| "title": "Asset tag", | |
| "description": "A unique tag used to identify this device", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "site": { | |
| "title": "Site", | |
| "type": "integer" | |
| }, | |
| "rack": { | |
| "title": "Rack", | |
| "type": "integer" | |
| }, | |
| "position": { | |
| "title": "Position (U)", | |
| "description": "The lowest-numbered unit occupied by the device", | |
| "type": "integer", | |
| "maximum": 32767, | |
| "minimum": 1 | |
| }, | |
| "face": { | |
| "title": "Rack face", | |
| "type": "string", | |
| "enum": [ | |
| 0, | |
| 1 | |
| ] | |
| }, | |
| "status": { | |
| "title": "Status", | |
| "type": "string", | |
| "enum": [ | |
| 1, | |
| 0, | |
| 2, | |
| 3, | |
| 4, | |
| 5 | |
| ] | |
| }, | |
| "primary_ip4": { | |
| "title": "Primary IPv4", | |
| "type": "integer" | |
| }, | |
| "primary_ip6": { | |
| "title": "Primary IPv6", | |
| "type": "integer" | |
| }, | |
| "cluster": { | |
| "title": "Cluster", | |
| "type": "integer" | |
| }, | |
| "comments": { | |
| "title": "Comments", | |
| "type": "string" | |
| }, | |
| "custom_fields": { | |
| "title": "Custom fields", | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "PeerInterface": { | |
| "title": "Interface a", | |
| "required": [ | |
| "device", | |
| "name", | |
| "form_factor", | |
| "lag" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "url": { | |
| "title": "Url", | |
| "type": "string", | |
| "format": "uri", | |
| "readOnly": true | |
| }, | |
| "device": { | |
| "$ref": "#/definitions/NestedDevice" | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 64 | |
| }, | |
| "form_factor": { | |
| "title": "Form factor", | |
| "type": "string" | |
| }, | |
| "enabled": { | |
| "title": "Enabled", | |
| "type": "boolean" | |
| }, | |
| "lag": { | |
| "$ref": "#/definitions/NestedInterface" | |
| }, | |
| "mtu": { | |
| "title": "MTU", | |
| "type": "integer", | |
| "maximum": 32767, | |
| "minimum": 0 | |
| }, | |
| "mac_address": { | |
| "title": "MAC Address", | |
| "type": "string" | |
| }, | |
| "mgmt_only": { | |
| "title": "OOB Management", | |
| "description": "This interface is used only for out-of-band management", | |
| "type": "boolean" | |
| }, | |
| "description": { | |
| "title": "Description", | |
| "type": "string", | |
| "maxLength": 100 | |
| } | |
| } | |
| }, | |
| "InterfaceConnection": { | |
| "required": [ | |
| "interface_a", | |
| "interface_b", | |
| "connection_status" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "interface_a": { | |
| "$ref": "#/definitions/PeerInterface" | |
| }, | |
| "interface_b": { | |
| "$ref": "#/definitions/PeerInterface" | |
| }, | |
| "connection_status": { | |
| "title": "Connection status", | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "WritableInterfaceConnection": { | |
| "required": [ | |
| "interface_a", | |
| "interface_b" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "interface_a": { | |
| "title": "Interface a", | |
| "type": "integer" | |
| }, | |
| "interface_b": { | |
| "title": "Interface b", | |
| "type": "integer" | |
| }, | |
| "connection_status": { | |
| "title": "Status", | |
| "type": "string", | |
| "enum": [ | |
| false, | |
| true | |
| ] | |
| } | |
| } | |
| }, | |
| "InterfaceTemplate": { | |
| "required": [ | |
| "device_type", | |
| "name", | |
| "form_factor" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "device_type": { | |
| "$ref": "#/definitions/NestedDeviceType" | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 64 | |
| }, | |
| "form_factor": { | |
| "title": "Form factor", | |
| "type": "string" | |
| }, | |
| "mgmt_only": { | |
| "title": "Management only", | |
| "type": "boolean" | |
| } | |
| } | |
| }, | |
| "WritableInterfaceTemplate": { | |
| "required": [ | |
| "device_type", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "device_type": { | |
| "title": "Device type", | |
| "type": "integer" | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 64 | |
| }, | |
| "form_factor": { | |
| "title": "Form factor", | |
| "type": "string", | |
| "enum": [ | |
| 0, | |
| 200, | |
| 800, | |
| 1000, | |
| 1150, | |
| 1170, | |
| 1050, | |
| 1100, | |
| 1200, | |
| 1300, | |
| 1310, | |
| 1320, | |
| 1350, | |
| 1400, | |
| 1500, | |
| 1510, | |
| 1520, | |
| 1550, | |
| 1600, | |
| 2600, | |
| 2610, | |
| 2620, | |
| 2630, | |
| 2640, | |
| 3010, | |
| 3020, | |
| 3040, | |
| 3080, | |
| 3160, | |
| 4000, | |
| 4010, | |
| 4040, | |
| 4050, | |
| 5000, | |
| 5050, | |
| 5100, | |
| 5150, | |
| 5200, | |
| 32767 | |
| ] | |
| }, | |
| "mgmt_only": { | |
| "title": "Management only", | |
| "type": "boolean" | |
| } | |
| } | |
| }, | |
| "WritableInterface": { | |
| "required": [ | |
| "device", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "device": { | |
| "title": "Device", | |
| "type": "integer" | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 64 | |
| }, | |
| "form_factor": { | |
| "title": "Form factor", | |
| "type": "string", | |
| "enum": [ | |
| 0, | |
| 200, | |
| 800, | |
| 1000, | |
| 1150, | |
| 1170, | |
| 1050, | |
| 1100, | |
| 1200, | |
| 1300, | |
| 1310, | |
| 1320, | |
| 1350, | |
| 1400, | |
| 1500, | |
| 1510, | |
| 1520, | |
| 1550, | |
| 1600, | |
| 2600, | |
| 2610, | |
| 2620, | |
| 2630, | |
| 2640, | |
| 3010, | |
| 3020, | |
| 3040, | |
| 3080, | |
| 3160, | |
| 4000, | |
| 4010, | |
| 4040, | |
| 4050, | |
| 5000, | |
| 5050, | |
| 5100, | |
| 5150, | |
| 5200, | |
| 32767 | |
| ] | |
| }, | |
| "enabled": { | |
| "title": "Enabled", | |
| "type": "boolean" | |
| }, | |
| "lag": { | |
| "title": "Parent LAG", | |
| "type": "integer" | |
| }, | |
| "mtu": { | |
| "title": "MTU", | |
| "type": "integer", | |
| "maximum": 32767, | |
| "minimum": 0 | |
| }, | |
| "mac_address": { | |
| "title": "MAC Address", | |
| "type": "string" | |
| }, | |
| "mgmt_only": { | |
| "title": "OOB Management", | |
| "description": "This interface is used only for out-of-band management", | |
| "type": "boolean" | |
| }, | |
| "description": { | |
| "title": "Description", | |
| "type": "string", | |
| "maxLength": 100 | |
| } | |
| } | |
| }, | |
| "InventoryItem": { | |
| "required": [ | |
| "device", | |
| "parent", | |
| "name", | |
| "manufacturer" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "device": { | |
| "$ref": "#/definitions/NestedDevice" | |
| }, | |
| "parent": { | |
| "title": "Parent", | |
| "type": "integer" | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "manufacturer": { | |
| "$ref": "#/definitions/NestedManufacturer" | |
| }, | |
| "part_id": { | |
| "title": "Part ID", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "serial": { | |
| "title": "Serial number", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "asset_tag": { | |
| "title": "Asset tag", | |
| "description": "A unique tag used to identify this item", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "discovered": { | |
| "title": "Discovered", | |
| "type": "boolean" | |
| }, | |
| "description": { | |
| "title": "Description", | |
| "type": "string", | |
| "maxLength": 100 | |
| } | |
| } | |
| }, | |
| "WritableInventoryItem": { | |
| "required": [ | |
| "device", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "device": { | |
| "title": "Device", | |
| "type": "integer" | |
| }, | |
| "parent": { | |
| "title": "Parent", | |
| "type": "integer" | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "manufacturer": { | |
| "title": "Manufacturer", | |
| "type": "integer" | |
| }, | |
| "part_id": { | |
| "title": "Part ID", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "serial": { | |
| "title": "Serial number", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "asset_tag": { | |
| "title": "Asset tag", | |
| "description": "A unique tag used to identify this item", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "discovered": { | |
| "title": "Discovered", | |
| "type": "boolean" | |
| }, | |
| "description": { | |
| "title": "Description", | |
| "type": "string", | |
| "maxLength": 100 | |
| } | |
| } | |
| }, | |
| "Manufacturer": { | |
| "required": [ | |
| "name", | |
| "slug" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "slug": { | |
| "title": "Slug", | |
| "type": "string", | |
| "format": "slug", | |
| "pattern": "^[-a-zA-Z0-9_]+$", | |
| "maxLength": 50 | |
| } | |
| } | |
| }, | |
| "Platform": { | |
| "required": [ | |
| "name", | |
| "slug" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "slug": { | |
| "title": "Slug", | |
| "type": "string", | |
| "format": "slug", | |
| "pattern": "^[-a-zA-Z0-9_]+$", | |
| "maxLength": 50 | |
| }, | |
| "napalm_driver": { | |
| "title": "NAPALM driver", | |
| "description": "The name of the NAPALM driver to use when interacting with devices.", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "rpc_client": { | |
| "title": "Legacy RPC client", | |
| "type": "string", | |
| "enum": [ | |
| "juniper-junos", | |
| "cisco-ios", | |
| "opengear" | |
| ] | |
| } | |
| } | |
| }, | |
| "PowerOutlet": { | |
| "title": "Power outlet", | |
| "required": [ | |
| "device", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "device": { | |
| "$ref": "#/definitions/NestedDevice" | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "connected_port": { | |
| "title": "Connected port", | |
| "type": "string", | |
| "readOnly": true | |
| } | |
| } | |
| }, | |
| "PowerPort": { | |
| "required": [ | |
| "device", | |
| "name", | |
| "power_outlet" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "device": { | |
| "$ref": "#/definitions/NestedDevice" | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "power_outlet": { | |
| "$ref": "#/definitions/PowerOutlet" | |
| }, | |
| "connection_status": { | |
| "title": "Connection status", | |
| "type": "string", | |
| "enum": [ | |
| false, | |
| true | |
| ] | |
| } | |
| } | |
| }, | |
| "PowerOutletTemplate": { | |
| "required": [ | |
| "device_type", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "device_type": { | |
| "$ref": "#/definitions/NestedDeviceType" | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| } | |
| } | |
| }, | |
| "WritablePowerOutletTemplate": { | |
| "required": [ | |
| "device_type", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "device_type": { | |
| "title": "Device type", | |
| "type": "integer" | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| } | |
| } | |
| }, | |
| "WritablePowerOutlet": { | |
| "required": [ | |
| "device", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "device": { | |
| "title": "Device", | |
| "type": "integer" | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| } | |
| } | |
| }, | |
| "PowerPortTemplate": { | |
| "required": [ | |
| "device_type", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "device_type": { | |
| "$ref": "#/definitions/NestedDeviceType" | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| } | |
| } | |
| }, | |
| "WritablePowerPortTemplate": { | |
| "required": [ | |
| "device_type", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "device_type": { | |
| "title": "Device type", | |
| "type": "integer" | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| } | |
| } | |
| }, | |
| "WritablePowerPort": { | |
| "required": [ | |
| "device", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "device": { | |
| "title": "Device", | |
| "type": "integer" | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "power_outlet": { | |
| "title": "Power outlet", | |
| "type": "integer" | |
| }, | |
| "connection_status": { | |
| "title": "Connection status", | |
| "type": "string", | |
| "enum": [ | |
| false, | |
| true | |
| ] | |
| } | |
| } | |
| }, | |
| "RackGroup": { | |
| "required": [ | |
| "name", | |
| "slug", | |
| "site" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "slug": { | |
| "title": "Slug", | |
| "type": "string", | |
| "format": "slug", | |
| "pattern": "^[-a-zA-Z0-9_]+$", | |
| "maxLength": 50 | |
| }, | |
| "site": { | |
| "$ref": "#/definitions/NestedSite" | |
| } | |
| } | |
| }, | |
| "WritableRackGroup": { | |
| "required": [ | |
| "name", | |
| "slug", | |
| "site" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "slug": { | |
| "title": "Slug", | |
| "type": "string", | |
| "format": "slug", | |
| "pattern": "^[-a-zA-Z0-9_]+$", | |
| "maxLength": 50 | |
| }, | |
| "site": { | |
| "title": "Site", | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "RackReservation": { | |
| "required": [ | |
| "rack", | |
| "units", | |
| "user", | |
| "description" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "rack": { | |
| "$ref": "#/definitions/NestedRack" | |
| }, | |
| "units": { | |
| "type": "array", | |
| "items": { | |
| "title": "Units", | |
| "type": "integer", | |
| "maximum": 32767, | |
| "minimum": 0 | |
| } | |
| }, | |
| "created": { | |
| "title": "Created", | |
| "type": "string", | |
| "format": "date-time", | |
| "readOnly": true | |
| }, | |
| "user": { | |
| "title": "User", | |
| "type": "integer" | |
| }, | |
| "description": { | |
| "title": "Description", | |
| "type": "string", | |
| "maxLength": 100 | |
| } | |
| } | |
| }, | |
| "WritableRackReservation": { | |
| "required": [ | |
| "rack", | |
| "units", | |
| "user", | |
| "description" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "rack": { | |
| "title": "Rack", | |
| "type": "integer" | |
| }, | |
| "units": { | |
| "type": "array", | |
| "items": { | |
| "title": "Units", | |
| "type": "integer", | |
| "maximum": 32767, | |
| "minimum": 0 | |
| } | |
| }, | |
| "user": { | |
| "title": "User", | |
| "type": "integer" | |
| }, | |
| "description": { | |
| "title": "Description", | |
| "type": "string", | |
| "maxLength": 100 | |
| } | |
| } | |
| }, | |
| "RackRole": { | |
| "required": [ | |
| "name", | |
| "slug", | |
| "color" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "slug": { | |
| "title": "Slug", | |
| "type": "string", | |
| "format": "slug", | |
| "pattern": "^[-a-zA-Z0-9_]+$", | |
| "maxLength": 50 | |
| }, | |
| "color": { | |
| "title": "Color", | |
| "type": "string", | |
| "pattern": "^[0-9a-f]{6}$", | |
| "maxLength": 6 | |
| } | |
| } | |
| }, | |
| "NestedRackGroup": { | |
| "title": "Group", | |
| "required": [ | |
| "name", | |
| "slug" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "url": { | |
| "title": "Url", | |
| "type": "string", | |
| "format": "uri", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "slug": { | |
| "title": "Slug", | |
| "type": "string", | |
| "format": "slug", | |
| "pattern": "^[-a-zA-Z0-9_]+$", | |
| "maxLength": 50 | |
| } | |
| } | |
| }, | |
| "NestedRackRole": { | |
| "title": "Role", | |
| "required": [ | |
| "name", | |
| "slug" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "url": { | |
| "title": "Url", | |
| "type": "string", | |
| "format": "uri", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "slug": { | |
| "title": "Slug", | |
| "type": "string", | |
| "format": "slug", | |
| "pattern": "^[-a-zA-Z0-9_]+$", | |
| "maxLength": 50 | |
| } | |
| } | |
| }, | |
| "Rack": { | |
| "required": [ | |
| "name", | |
| "facility_id", | |
| "site", | |
| "group", | |
| "tenant", | |
| "role", | |
| "type", | |
| "width" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "facility_id": { | |
| "title": "Facility ID", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "display_name": { | |
| "title": "Display name", | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "site": { | |
| "$ref": "#/definitions/NestedSite" | |
| }, | |
| "group": { | |
| "$ref": "#/definitions/NestedRackGroup" | |
| }, | |
| "tenant": { | |
| "$ref": "#/definitions/NestedTenant" | |
| }, | |
| "role": { | |
| "$ref": "#/definitions/NestedRackRole" | |
| }, | |
| "serial": { | |
| "title": "Serial number", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "type": { | |
| "title": "Type", | |
| "type": "string" | |
| }, | |
| "width": { | |
| "title": "Width", | |
| "type": "string" | |
| }, | |
| "u_height": { | |
| "title": "Height (U)", | |
| "type": "integer", | |
| "maximum": 100, | |
| "minimum": 1 | |
| }, | |
| "desc_units": { | |
| "title": "Descending units", | |
| "description": "Units are numbered top-to-bottom", | |
| "type": "boolean" | |
| }, | |
| "comments": { | |
| "title": "Comments", | |
| "type": "string" | |
| }, | |
| "custom_fields": { | |
| "title": "Custom fields", | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "WritableRack": { | |
| "required": [ | |
| "name", | |
| "site" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "facility_id": { | |
| "title": "Facility ID", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "site": { | |
| "title": "Site", | |
| "type": "integer" | |
| }, | |
| "group": { | |
| "title": "Group", | |
| "type": "integer" | |
| }, | |
| "tenant": { | |
| "title": "Tenant", | |
| "type": "integer" | |
| }, | |
| "role": { | |
| "title": "Role", | |
| "type": "integer" | |
| }, | |
| "serial": { | |
| "title": "Serial number", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "type": { | |
| "title": "Type", | |
| "type": "string", | |
| "enum": [ | |
| 100, | |
| 200, | |
| 300, | |
| 1000, | |
| 1100 | |
| ] | |
| }, | |
| "width": { | |
| "title": "Width", | |
| "description": "Rail-to-rail width", | |
| "type": "string", | |
| "enum": [ | |
| 19, | |
| 23 | |
| ] | |
| }, | |
| "u_height": { | |
| "title": "Height (U)", | |
| "type": "integer", | |
| "maximum": 100, | |
| "minimum": 1 | |
| }, | |
| "desc_units": { | |
| "title": "Descending units", | |
| "description": "Units are numbered top-to-bottom", | |
| "type": "boolean" | |
| }, | |
| "comments": { | |
| "title": "Comments", | |
| "type": "string" | |
| }, | |
| "custom_fields": { | |
| "title": "Custom fields", | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "NestedRegion": { | |
| "title": "Parent", | |
| "required": [ | |
| "name", | |
| "slug" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "url": { | |
| "title": "Url", | |
| "type": "string", | |
| "format": "uri", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "slug": { | |
| "title": "Slug", | |
| "type": "string", | |
| "format": "slug", | |
| "pattern": "^[-a-zA-Z0-9_]+$", | |
| "maxLength": 50 | |
| } | |
| } | |
| }, | |
| "Region": { | |
| "required": [ | |
| "name", | |
| "slug", | |
| "parent" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "slug": { | |
| "title": "Slug", | |
| "type": "string", | |
| "format": "slug", | |
| "pattern": "^[-a-zA-Z0-9_]+$", | |
| "maxLength": 50 | |
| }, | |
| "parent": { | |
| "$ref": "#/definitions/NestedRegion" | |
| } | |
| } | |
| }, | |
| "WritableRegion": { | |
| "required": [ | |
| "name", | |
| "slug" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "slug": { | |
| "title": "Slug", | |
| "type": "string", | |
| "format": "slug", | |
| "pattern": "^[-a-zA-Z0-9_]+$", | |
| "maxLength": 50 | |
| }, | |
| "parent": { | |
| "title": "Parent", | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "Site": { | |
| "required": [ | |
| "name", | |
| "slug", | |
| "region", | |
| "tenant" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "slug": { | |
| "title": "Slug", | |
| "type": "string", | |
| "format": "slug", | |
| "pattern": "^[-a-zA-Z0-9_]+$", | |
| "maxLength": 50 | |
| }, | |
| "region": { | |
| "$ref": "#/definitions/NestedRegion" | |
| }, | |
| "tenant": { | |
| "$ref": "#/definitions/NestedTenant" | |
| }, | |
| "facility": { | |
| "title": "Facility", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "asn": { | |
| "title": "ASN", | |
| "type": "integer", | |
| "maximum": 4294967295, | |
| "minimum": 1 | |
| }, | |
| "physical_address": { | |
| "title": "Physical address", | |
| "type": "string", | |
| "maxLength": 200 | |
| }, | |
| "shipping_address": { | |
| "title": "Shipping address", | |
| "type": "string", | |
| "maxLength": 200 | |
| }, | |
| "contact_name": { | |
| "title": "Contact name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "contact_phone": { | |
| "title": "Contact phone", | |
| "type": "string", | |
| "maxLength": 20 | |
| }, | |
| "contact_email": { | |
| "title": "Contact E-mail", | |
| "type": "string", | |
| "format": "email", | |
| "maxLength": 254 | |
| }, | |
| "comments": { | |
| "title": "Comments", | |
| "type": "string" | |
| }, | |
| "custom_fields": { | |
| "title": "Custom fields", | |
| "type": "string" | |
| }, | |
| "count_prefixes": { | |
| "title": "Count prefixes", | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "count_vlans": { | |
| "title": "Count vlans", | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "count_racks": { | |
| "title": "Count racks", | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "count_devices": { | |
| "title": "Count devices", | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "count_circuits": { | |
| "title": "Count circuits", | |
| "type": "string", | |
| "readOnly": true | |
| } | |
| } | |
| }, | |
| "WritableSite": { | |
| "required": [ | |
| "name", | |
| "slug" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "slug": { | |
| "title": "Slug", | |
| "type": "string", | |
| "format": "slug", | |
| "pattern": "^[-a-zA-Z0-9_]+$", | |
| "maxLength": 50 | |
| }, | |
| "region": { | |
| "title": "Region", | |
| "type": "integer" | |
| }, | |
| "tenant": { | |
| "title": "Tenant", | |
| "type": "integer" | |
| }, | |
| "facility": { | |
| "title": "Facility", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "asn": { | |
| "title": "ASN", | |
| "type": "integer", | |
| "maximum": 4294967295, | |
| "minimum": 1 | |
| }, | |
| "physical_address": { | |
| "title": "Physical address", | |
| "type": "string", | |
| "maxLength": 200 | |
| }, | |
| "shipping_address": { | |
| "title": "Shipping address", | |
| "type": "string", | |
| "maxLength": 200 | |
| }, | |
| "contact_name": { | |
| "title": "Contact name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "contact_phone": { | |
| "title": "Contact phone", | |
| "type": "string", | |
| "maxLength": 20 | |
| }, | |
| "contact_email": { | |
| "title": "Contact E-mail", | |
| "type": "string", | |
| "format": "email", | |
| "maxLength": 254 | |
| }, | |
| "comments": { | |
| "title": "Comments", | |
| "type": "string" | |
| }, | |
| "custom_fields": { | |
| "title": "Custom fields", | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "ExportTemplate": { | |
| "required": [ | |
| "content_type", | |
| "name", | |
| "template_code" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "content_type": { | |
| "title": "Content type", | |
| "type": "integer" | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 100 | |
| }, | |
| "description": { | |
| "title": "Description", | |
| "type": "string", | |
| "maxLength": 200 | |
| }, | |
| "template_code": { | |
| "title": "Template code", | |
| "type": "string" | |
| }, | |
| "mime_type": { | |
| "title": "Mime type", | |
| "type": "string", | |
| "maxLength": 15 | |
| }, | |
| "file_extension": { | |
| "title": "File extension", | |
| "type": "string", | |
| "maxLength": 15 | |
| } | |
| } | |
| }, | |
| "Graph": { | |
| "required": [ | |
| "type", | |
| "name", | |
| "source" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "type": { | |
| "title": "Type", | |
| "type": "string" | |
| }, | |
| "weight": { | |
| "title": "Weight", | |
| "type": "integer", | |
| "maximum": 32767, | |
| "minimum": 0 | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 100 | |
| }, | |
| "source": { | |
| "title": "Source URL", | |
| "type": "string", | |
| "maxLength": 500 | |
| }, | |
| "link": { | |
| "title": "Link URL", | |
| "type": "string", | |
| "format": "uri", | |
| "maxLength": 200 | |
| } | |
| } | |
| }, | |
| "WritableGraph": { | |
| "required": [ | |
| "type", | |
| "name", | |
| "source" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "type": { | |
| "title": "Type", | |
| "type": "string", | |
| "enum": [ | |
| 100, | |
| 200, | |
| 300 | |
| ] | |
| }, | |
| "weight": { | |
| "title": "Weight", | |
| "type": "integer", | |
| "maximum": 32767, | |
| "minimum": 0 | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 100 | |
| }, | |
| "source": { | |
| "title": "Source URL", | |
| "type": "string", | |
| "maxLength": 500 | |
| }, | |
| "link": { | |
| "title": "Link URL", | |
| "type": "string", | |
| "format": "uri", | |
| "maxLength": 200 | |
| } | |
| } | |
| }, | |
| "ImageAttachment": { | |
| "required": [ | |
| "image", | |
| "image_height", | |
| "image_width" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "parent": { | |
| "title": "Parent", | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "image": { | |
| "title": "Image", | |
| "type": "string", | |
| "readOnly": true, | |
| "format": "uri" | |
| }, | |
| "image_height": { | |
| "title": "Image height", | |
| "type": "integer", | |
| "maximum": 32767, | |
| "minimum": 0 | |
| }, | |
| "image_width": { | |
| "title": "Image width", | |
| "type": "integer", | |
| "maximum": 32767, | |
| "minimum": 0 | |
| }, | |
| "created": { | |
| "title": "Created", | |
| "type": "string", | |
| "format": "date-time", | |
| "readOnly": true | |
| } | |
| } | |
| }, | |
| "WritableImageAttachment": { | |
| "required": [ | |
| "content_type", | |
| "object_id", | |
| "image" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "content_type": { | |
| "title": "Content type", | |
| "type": "string" | |
| }, | |
| "object_id": { | |
| "title": "Object id", | |
| "type": "integer", | |
| "maximum": 2147483647, | |
| "minimum": 0 | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "image": { | |
| "title": "Image", | |
| "type": "string", | |
| "readOnly": true, | |
| "format": "uri" | |
| } | |
| } | |
| }, | |
| "NestedUser": { | |
| "title": "User", | |
| "required": [ | |
| "username" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "username": { | |
| "title": "Username", | |
| "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.", | |
| "type": "string", | |
| "pattern": "^[\\w.@+-]+$", | |
| "maxLength": 150 | |
| } | |
| } | |
| }, | |
| "UserAction": { | |
| "required": [ | |
| "user", | |
| "action" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "time": { | |
| "title": "Time", | |
| "type": "string", | |
| "format": "date-time", | |
| "readOnly": true | |
| }, | |
| "user": { | |
| "$ref": "#/definitions/NestedUser" | |
| }, | |
| "action": { | |
| "title": "Action", | |
| "type": "string" | |
| }, | |
| "message": { | |
| "title": "Message", | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "TopologyMap": { | |
| "required": [ | |
| "name", | |
| "slug", | |
| "site", | |
| "device_patterns" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "slug": { | |
| "title": "Slug", | |
| "type": "string", | |
| "format": "slug", | |
| "pattern": "^[-a-zA-Z0-9_]+$", | |
| "maxLength": 50 | |
| }, | |
| "site": { | |
| "$ref": "#/definitions/NestedSite" | |
| }, | |
| "device_patterns": { | |
| "title": "Device patterns", | |
| "description": "Identify devices to include in the diagram using regular expressions, one per line. Each line will result in a new tier of the drawing. Separate multiple regexes within a line using semicolons. Devices will be rendered in the order they are defined.", | |
| "type": "string" | |
| }, | |
| "description": { | |
| "title": "Description", | |
| "type": "string", | |
| "maxLength": 100 | |
| } | |
| } | |
| }, | |
| "WritableTopologyMap": { | |
| "required": [ | |
| "name", | |
| "slug", | |
| "device_patterns" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "slug": { | |
| "title": "Slug", | |
| "type": "string", | |
| "format": "slug", | |
| "pattern": "^[-a-zA-Z0-9_]+$", | |
| "maxLength": 50 | |
| }, | |
| "site": { | |
| "title": "Site", | |
| "type": "integer" | |
| }, | |
| "device_patterns": { | |
| "title": "Device patterns", | |
| "description": "Identify devices to include in the diagram using regular expressions, one per line. Each line will result in a new tier of the drawing. Separate multiple regexes within a line using semicolons. Devices will be rendered in the order they are defined.", | |
| "type": "string" | |
| }, | |
| "description": { | |
| "title": "Description", | |
| "type": "string", | |
| "maxLength": 100 | |
| } | |
| } | |
| }, | |
| "NestedRIR": { | |
| "title": "Rir", | |
| "required": [ | |
| "name", | |
| "slug" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "url": { | |
| "title": "Url", | |
| "type": "string", | |
| "format": "uri", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "slug": { | |
| "title": "Slug", | |
| "type": "string", | |
| "format": "slug", | |
| "pattern": "^[-a-zA-Z0-9_]+$", | |
| "maxLength": 50 | |
| } | |
| } | |
| }, | |
| "Aggregate": { | |
| "required": [ | |
| "family", | |
| "prefix", | |
| "rir" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "family": { | |
| "title": "Family", | |
| "type": "string", | |
| "enum": [ | |
| 4, | |
| 6 | |
| ] | |
| }, | |
| "prefix": { | |
| "title": "Prefix", | |
| "type": "string" | |
| }, | |
| "rir": { | |
| "$ref": "#/definitions/NestedRIR" | |
| }, | |
| "date_added": { | |
| "title": "Date added", | |
| "type": "string", | |
| "format": "date" | |
| }, | |
| "description": { | |
| "title": "Description", | |
| "type": "string", | |
| "maxLength": 100 | |
| }, | |
| "custom_fields": { | |
| "title": "Custom fields", | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "WritableAggregate": { | |
| "required": [ | |
| "prefix", | |
| "rir" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "prefix": { | |
| "title": "Prefix", | |
| "type": "string" | |
| }, | |
| "rir": { | |
| "title": "RIR", | |
| "type": "integer" | |
| }, | |
| "date_added": { | |
| "title": "Date added", | |
| "type": "string", | |
| "format": "date" | |
| }, | |
| "description": { | |
| "title": "Description", | |
| "type": "string", | |
| "maxLength": 100 | |
| }, | |
| "custom_fields": { | |
| "title": "Custom fields", | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "NestedVRF": { | |
| "title": "Vrf", | |
| "required": [ | |
| "name", | |
| "rd" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "url": { | |
| "title": "Url", | |
| "type": "string", | |
| "format": "uri", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "rd": { | |
| "title": "Route distinguisher", | |
| "type": "string", | |
| "maxLength": 21 | |
| } | |
| } | |
| }, | |
| "NestedVirtualMachine": { | |
| "title": "Virtual machine", | |
| "required": [ | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "url": { | |
| "title": "Url", | |
| "type": "string", | |
| "format": "uri", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 64 | |
| } | |
| } | |
| }, | |
| "IPAddressInterface": { | |
| "title": "Interface", | |
| "required": [ | |
| "device", | |
| "virtual_machine", | |
| "name", | |
| "form_factor", | |
| "lag", | |
| "circuit_termination" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "device": { | |
| "$ref": "#/definitions/NestedDevice" | |
| }, | |
| "virtual_machine": { | |
| "$ref": "#/definitions/NestedVirtualMachine" | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 64 | |
| }, | |
| "form_factor": { | |
| "title": "Form factor", | |
| "type": "string" | |
| }, | |
| "enabled": { | |
| "title": "Enabled", | |
| "type": "boolean" | |
| }, | |
| "lag": { | |
| "$ref": "#/definitions/NestedInterface" | |
| }, | |
| "mtu": { | |
| "title": "MTU", | |
| "type": "integer", | |
| "maximum": 32767, | |
| "minimum": 0 | |
| }, | |
| "mac_address": { | |
| "title": "MAC Address", | |
| "type": "string" | |
| }, | |
| "mgmt_only": { | |
| "title": "OOB Management", | |
| "description": "This interface is used only for out-of-band management", | |
| "type": "boolean" | |
| }, | |
| "description": { | |
| "title": "Description", | |
| "type": "string", | |
| "maxLength": 100 | |
| }, | |
| "is_connected": { | |
| "title": "Is connected", | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "interface_connection": { | |
| "title": "Interface connection", | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "circuit_termination": { | |
| "$ref": "#/definitions/InterfaceCircuitTermination" | |
| } | |
| } | |
| }, | |
| "NestedIPAddress": { | |
| "title": "Nat inside", | |
| "required": [ | |
| "address" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "url": { | |
| "title": "Url", | |
| "type": "string", | |
| "format": "uri", | |
| "readOnly": true | |
| }, | |
| "family": { | |
| "title": "Family", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "address": { | |
| "title": "Address", | |
| "description": "IPv4 or IPv6 address (with mask)", | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "IPAddress": { | |
| "required": [ | |
| "address", | |
| "vrf", | |
| "tenant", | |
| "status", | |
| "role", | |
| "interface", | |
| "nat_inside", | |
| "nat_outside" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "family": { | |
| "title": "Family", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "address": { | |
| "title": "Address", | |
| "description": "IPv4 or IPv6 address (with mask)", | |
| "type": "string" | |
| }, | |
| "vrf": { | |
| "$ref": "#/definitions/NestedVRF" | |
| }, | |
| "tenant": { | |
| "$ref": "#/definitions/NestedTenant" | |
| }, | |
| "status": { | |
| "title": "Status", | |
| "type": "string" | |
| }, | |
| "role": { | |
| "title": "Role", | |
| "type": "string" | |
| }, | |
| "interface": { | |
| "$ref": "#/definitions/IPAddressInterface" | |
| }, | |
| "description": { | |
| "title": "Description", | |
| "type": "string", | |
| "maxLength": 100 | |
| }, | |
| "nat_inside": { | |
| "$ref": "#/definitions/NestedIPAddress" | |
| }, | |
| "nat_outside": { | |
| "$ref": "#/definitions/NestedIPAddress" | |
| }, | |
| "custom_fields": { | |
| "title": "Custom fields", | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "WritableIPAddress": { | |
| "required": [ | |
| "address" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "address": { | |
| "title": "Address", | |
| "description": "IPv4 or IPv6 address (with mask)", | |
| "type": "string" | |
| }, | |
| "vrf": { | |
| "title": "VRF", | |
| "type": "integer" | |
| }, | |
| "tenant": { | |
| "title": "Tenant", | |
| "type": "integer" | |
| }, | |
| "status": { | |
| "title": "Status", | |
| "description": "The operational status of this IP", | |
| "type": "string", | |
| "enum": [ | |
| 1, | |
| 2, | |
| 3, | |
| 5 | |
| ] | |
| }, | |
| "role": { | |
| "title": "Role", | |
| "description": "The functional role of this IP", | |
| "type": "string", | |
| "enum": [ | |
| 10, | |
| 20, | |
| 30, | |
| 40, | |
| 41, | |
| 42, | |
| 43, | |
| 44 | |
| ] | |
| }, | |
| "interface": { | |
| "title": "Interface", | |
| "type": "integer" | |
| }, | |
| "description": { | |
| "title": "Description", | |
| "type": "string", | |
| "maxLength": 100 | |
| }, | |
| "nat_inside": { | |
| "title": "NAT (Inside)", | |
| "description": "The IP for which this address is the \"outside\" IP", | |
| "type": "integer" | |
| }, | |
| "custom_fields": { | |
| "title": "Custom fields", | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "NestedVLAN": { | |
| "title": "Vlan", | |
| "required": [ | |
| "vid", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "url": { | |
| "title": "Url", | |
| "type": "string", | |
| "format": "uri", | |
| "readOnly": true | |
| }, | |
| "vid": { | |
| "title": "ID", | |
| "type": "integer", | |
| "maximum": 4094, | |
| "minimum": 1 | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 64 | |
| }, | |
| "display_name": { | |
| "title": "Display name", | |
| "type": "string", | |
| "readOnly": true | |
| } | |
| } | |
| }, | |
| "NestedRole": { | |
| "title": "Role", | |
| "required": [ | |
| "name", | |
| "slug" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "url": { | |
| "title": "Url", | |
| "type": "string", | |
| "format": "uri", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "slug": { | |
| "title": "Slug", | |
| "type": "string", | |
| "format": "slug", | |
| "pattern": "^[-a-zA-Z0-9_]+$", | |
| "maxLength": 50 | |
| } | |
| } | |
| }, | |
| "Prefix": { | |
| "required": [ | |
| "prefix", | |
| "site", | |
| "vrf", | |
| "tenant", | |
| "vlan", | |
| "status", | |
| "role" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "family": { | |
| "title": "Family", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "prefix": { | |
| "title": "Prefix", | |
| "description": "IPv4 or IPv6 network with mask", | |
| "type": "string" | |
| }, | |
| "site": { | |
| "$ref": "#/definitions/NestedSite" | |
| }, | |
| "vrf": { | |
| "$ref": "#/definitions/NestedVRF" | |
| }, | |
| "tenant": { | |
| "$ref": "#/definitions/NestedTenant" | |
| }, | |
| "vlan": { | |
| "$ref": "#/definitions/NestedVLAN" | |
| }, | |
| "status": { | |
| "title": "Status", | |
| "type": "string" | |
| }, | |
| "role": { | |
| "$ref": "#/definitions/NestedRole" | |
| }, | |
| "is_pool": { | |
| "title": "Is a pool", | |
| "description": "All IP addresses within this prefix are considered usable", | |
| "type": "boolean" | |
| }, | |
| "description": { | |
| "title": "Description", | |
| "type": "string", | |
| "maxLength": 100 | |
| }, | |
| "custom_fields": { | |
| "title": "Custom fields", | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "WritablePrefix": { | |
| "required": [ | |
| "prefix" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "prefix": { | |
| "title": "Prefix", | |
| "description": "IPv4 or IPv6 network with mask", | |
| "type": "string" | |
| }, | |
| "site": { | |
| "title": "Site", | |
| "type": "integer" | |
| }, | |
| "vrf": { | |
| "title": "VRF", | |
| "type": "integer" | |
| }, | |
| "tenant": { | |
| "title": "Tenant", | |
| "type": "integer" | |
| }, | |
| "vlan": { | |
| "title": "VLAN", | |
| "type": "integer" | |
| }, | |
| "status": { | |
| "title": "Status", | |
| "description": "Operational status of this prefix", | |
| "type": "string", | |
| "enum": [ | |
| 0, | |
| 1, | |
| 2, | |
| 3 | |
| ] | |
| }, | |
| "role": { | |
| "title": "Role", | |
| "description": "The primary function of this prefix", | |
| "type": "integer" | |
| }, | |
| "is_pool": { | |
| "title": "Is a pool", | |
| "description": "All IP addresses within this prefix are considered usable", | |
| "type": "boolean" | |
| }, | |
| "description": { | |
| "title": "Description", | |
| "type": "string", | |
| "maxLength": 100 | |
| }, | |
| "custom_fields": { | |
| "title": "Custom fields", | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "RIR": { | |
| "required": [ | |
| "name", | |
| "slug" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "slug": { | |
| "title": "Slug", | |
| "type": "string", | |
| "format": "slug", | |
| "pattern": "^[-a-zA-Z0-9_]+$", | |
| "maxLength": 50 | |
| }, | |
| "is_private": { | |
| "title": "Private", | |
| "description": "IP space managed by this RIR is considered private", | |
| "type": "boolean" | |
| } | |
| } | |
| }, | |
| "Role": { | |
| "required": [ | |
| "name", | |
| "slug" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "slug": { | |
| "title": "Slug", | |
| "type": "string", | |
| "format": "slug", | |
| "pattern": "^[-a-zA-Z0-9_]+$", | |
| "maxLength": 50 | |
| }, | |
| "weight": { | |
| "title": "Weight", | |
| "type": "integer", | |
| "maximum": 32767, | |
| "minimum": 0 | |
| } | |
| } | |
| }, | |
| "Service": { | |
| "required": [ | |
| "device", | |
| "virtual_machine", | |
| "name", | |
| "port", | |
| "protocol", | |
| "ipaddresses" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "device": { | |
| "$ref": "#/definitions/NestedDevice" | |
| }, | |
| "virtual_machine": { | |
| "$ref": "#/definitions/NestedVirtualMachine" | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 30 | |
| }, | |
| "port": { | |
| "title": "Port number", | |
| "type": "integer", | |
| "maximum": 65535, | |
| "minimum": 1 | |
| }, | |
| "protocol": { | |
| "title": "Protocol", | |
| "type": "string" | |
| }, | |
| "ipaddresses": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/NestedIPAddress" | |
| } | |
| }, | |
| "description": { | |
| "title": "Description", | |
| "type": "string", | |
| "maxLength": 100 | |
| } | |
| } | |
| }, | |
| "WritableService": { | |
| "required": [ | |
| "name", | |
| "port", | |
| "protocol" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "device": { | |
| "title": "Device", | |
| "type": "integer" | |
| }, | |
| "virtual_machine": { | |
| "title": "Virtual machine", | |
| "type": "integer" | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 30 | |
| }, | |
| "port": { | |
| "title": "Port number", | |
| "type": "integer", | |
| "maximum": 65535, | |
| "minimum": 1 | |
| }, | |
| "protocol": { | |
| "title": "Protocol", | |
| "type": "string", | |
| "enum": [ | |
| 6, | |
| 17 | |
| ] | |
| }, | |
| "ipaddresses": { | |
| "type": "array", | |
| "items": { | |
| "title": "IP addresses", | |
| "type": "integer" | |
| }, | |
| "uniqueItems": true | |
| }, | |
| "description": { | |
| "title": "Description", | |
| "type": "string", | |
| "maxLength": 100 | |
| } | |
| } | |
| }, | |
| "VLANGroup": { | |
| "required": [ | |
| "name", | |
| "slug", | |
| "site" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "slug": { | |
| "title": "Slug", | |
| "type": "string", | |
| "format": "slug", | |
| "pattern": "^[-a-zA-Z0-9_]+$", | |
| "maxLength": 50 | |
| }, | |
| "site": { | |
| "$ref": "#/definitions/NestedSite" | |
| } | |
| } | |
| }, | |
| "WritableVLANGroup": { | |
| "required": [ | |
| "name", | |
| "slug" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "slug": { | |
| "title": "Slug", | |
| "type": "string", | |
| "format": "slug", | |
| "pattern": "^[-a-zA-Z0-9_]+$", | |
| "maxLength": 50 | |
| }, | |
| "site": { | |
| "title": "Site", | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "NestedVLANGroup": { | |
| "title": "Group", | |
| "required": [ | |
| "name", | |
| "slug" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "url": { | |
| "title": "Url", | |
| "type": "string", | |
| "format": "uri", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "slug": { | |
| "title": "Slug", | |
| "type": "string", | |
| "format": "slug", | |
| "pattern": "^[-a-zA-Z0-9_]+$", | |
| "maxLength": 50 | |
| } | |
| } | |
| }, | |
| "VLAN": { | |
| "required": [ | |
| "site", | |
| "group", | |
| "vid", | |
| "name", | |
| "tenant", | |
| "status", | |
| "role" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "site": { | |
| "$ref": "#/definitions/NestedSite" | |
| }, | |
| "group": { | |
| "$ref": "#/definitions/NestedVLANGroup" | |
| }, | |
| "vid": { | |
| "title": "ID", | |
| "type": "integer", | |
| "maximum": 4094, | |
| "minimum": 1 | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 64 | |
| }, | |
| "tenant": { | |
| "$ref": "#/definitions/NestedTenant" | |
| }, | |
| "status": { | |
| "title": "Status", | |
| "type": "string" | |
| }, | |
| "role": { | |
| "$ref": "#/definitions/NestedRole" | |
| }, | |
| "description": { | |
| "title": "Description", | |
| "type": "string", | |
| "maxLength": 100 | |
| }, | |
| "display_name": { | |
| "title": "Display name", | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "custom_fields": { | |
| "title": "Custom fields", | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "WritableVLAN": { | |
| "required": [ | |
| "vid", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "site": { | |
| "title": "Site", | |
| "type": "integer" | |
| }, | |
| "group": { | |
| "title": "Group", | |
| "type": "integer" | |
| }, | |
| "vid": { | |
| "title": "ID", | |
| "type": "integer", | |
| "maximum": 4094, | |
| "minimum": 1 | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 64 | |
| }, | |
| "tenant": { | |
| "title": "Tenant", | |
| "type": "integer" | |
| }, | |
| "status": { | |
| "title": "Status", | |
| "type": "string", | |
| "enum": [ | |
| 1, | |
| 2, | |
| 3 | |
| ] | |
| }, | |
| "role": { | |
| "title": "Role", | |
| "type": "integer" | |
| }, | |
| "description": { | |
| "title": "Description", | |
| "type": "string", | |
| "maxLength": 100 | |
| }, | |
| "custom_fields": { | |
| "title": "Custom fields", | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "VRF": { | |
| "required": [ | |
| "name", | |
| "rd", | |
| "tenant" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "rd": { | |
| "title": "Route distinguisher", | |
| "type": "string", | |
| "maxLength": 21 | |
| }, | |
| "tenant": { | |
| "$ref": "#/definitions/NestedTenant" | |
| }, | |
| "enforce_unique": { | |
| "title": "Enforce unique space", | |
| "description": "Prevent duplicate prefixes/IP addresses within this VRF", | |
| "type": "boolean" | |
| }, | |
| "description": { | |
| "title": "Description", | |
| "type": "string", | |
| "maxLength": 100 | |
| }, | |
| "display_name": { | |
| "title": "Display name", | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "custom_fields": { | |
| "title": "Custom fields", | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "WritableVRF": { | |
| "required": [ | |
| "name", | |
| "rd" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "rd": { | |
| "title": "Route distinguisher", | |
| "type": "string", | |
| "maxLength": 21 | |
| }, | |
| "tenant": { | |
| "title": "Tenant", | |
| "type": "integer" | |
| }, | |
| "enforce_unique": { | |
| "title": "Enforce unique space", | |
| "description": "Prevent duplicate prefixes/IP addresses within this VRF", | |
| "type": "boolean" | |
| }, | |
| "description": { | |
| "title": "Description", | |
| "type": "string", | |
| "maxLength": 100 | |
| }, | |
| "custom_fields": { | |
| "title": "Custom fields", | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "SecretRole": { | |
| "required": [ | |
| "name", | |
| "slug" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "slug": { | |
| "title": "Slug", | |
| "type": "string", | |
| "format": "slug", | |
| "pattern": "^[-a-zA-Z0-9_]+$", | |
| "maxLength": 50 | |
| } | |
| } | |
| }, | |
| "NestedSecretRole": { | |
| "title": "Role", | |
| "required": [ | |
| "name", | |
| "slug" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "url": { | |
| "title": "Url", | |
| "type": "string", | |
| "format": "uri", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "slug": { | |
| "title": "Slug", | |
| "type": "string", | |
| "format": "slug", | |
| "pattern": "^[-a-zA-Z0-9_]+$", | |
| "maxLength": 50 | |
| } | |
| } | |
| }, | |
| "Secret": { | |
| "required": [ | |
| "device", | |
| "role", | |
| "name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "device": { | |
| "$ref": "#/definitions/NestedDevice" | |
| }, | |
| "role": { | |
| "$ref": "#/definitions/NestedSecretRole" | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 100 | |
| }, | |
| "plaintext": { | |
| "title": "Plaintext", | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "hash": { | |
| "title": "Hash", | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "created": { | |
| "title": "Created", | |
| "type": "string", | |
| "format": "date", | |
| "readOnly": true | |
| }, | |
| "last_updated": { | |
| "title": "Last updated", | |
| "type": "string", | |
| "format": "date-time", | |
| "readOnly": true | |
| } | |
| } | |
| }, | |
| "WritableSecret": { | |
| "required": [ | |
| "device", | |
| "role", | |
| "plaintext" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "device": { | |
| "title": "Device", | |
| "type": "integer" | |
| }, | |
| "role": { | |
| "title": "Role", | |
| "type": "integer" | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 100 | |
| }, | |
| "plaintext": { | |
| "title": "Plaintext", | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "TenantGroup": { | |
| "required": [ | |
| "name", | |
| "slug" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "slug": { | |
| "title": "Slug", | |
| "type": "string", | |
| "format": "slug", | |
| "pattern": "^[-a-zA-Z0-9_]+$", | |
| "maxLength": 50 | |
| } | |
| } | |
| }, | |
| "NestedTenantGroup": { | |
| "title": "Group", | |
| "required": [ | |
| "name", | |
| "slug" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "url": { | |
| "title": "Url", | |
| "type": "string", | |
| "format": "uri", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "slug": { | |
| "title": "Slug", | |
| "type": "string", | |
| "format": "slug", | |
| "pattern": "^[-a-zA-Z0-9_]+$", | |
| "maxLength": 50 | |
| } | |
| } | |
| }, | |
| "Tenant": { | |
| "required": [ | |
| "name", | |
| "slug", | |
| "group" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 30 | |
| }, | |
| "slug": { | |
| "title": "Slug", | |
| "type": "string", | |
| "format": "slug", | |
| "pattern": "^[-a-zA-Z0-9_]+$", | |
| "maxLength": 50 | |
| }, | |
| "group": { | |
| "$ref": "#/definitions/NestedTenantGroup" | |
| }, | |
| "description": { | |
| "title": "Description", | |
| "description": "Long-form name (optional)", | |
| "type": "string", | |
| "maxLength": 100 | |
| }, | |
| "comments": { | |
| "title": "Comments", | |
| "type": "string" | |
| }, | |
| "custom_fields": { | |
| "title": "Custom fields", | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "WritableTenant": { | |
| "required": [ | |
| "name", | |
| "slug" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 30 | |
| }, | |
| "slug": { | |
| "title": "Slug", | |
| "type": "string", | |
| "format": "slug", | |
| "pattern": "^[-a-zA-Z0-9_]+$", | |
| "maxLength": 50 | |
| }, | |
| "group": { | |
| "title": "Group", | |
| "type": "integer" | |
| }, | |
| "description": { | |
| "title": "Description", | |
| "description": "Long-form name (optional)", | |
| "type": "string", | |
| "maxLength": 100 | |
| }, | |
| "comments": { | |
| "title": "Comments", | |
| "type": "string" | |
| }, | |
| "custom_fields": { | |
| "title": "Custom fields", | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "ClusterGroup": { | |
| "required": [ | |
| "name", | |
| "slug" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "slug": { | |
| "title": "Slug", | |
| "type": "string", | |
| "format": "slug", | |
| "pattern": "^[-a-zA-Z0-9_]+$", | |
| "maxLength": 50 | |
| } | |
| } | |
| }, | |
| "ClusterType": { | |
| "required": [ | |
| "name", | |
| "slug" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "slug": { | |
| "title": "Slug", | |
| "type": "string", | |
| "format": "slug", | |
| "pattern": "^[-a-zA-Z0-9_]+$", | |
| "maxLength": 50 | |
| } | |
| } | |
| }, | |
| "NestedClusterType": { | |
| "title": "Type", | |
| "required": [ | |
| "name", | |
| "slug" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "url": { | |
| "title": "Url", | |
| "type": "string", | |
| "format": "uri", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "slug": { | |
| "title": "Slug", | |
| "type": "string", | |
| "format": "slug", | |
| "pattern": "^[-a-zA-Z0-9_]+$", | |
| "maxLength": 50 | |
| } | |
| } | |
| }, | |
| "NestedClusterGroup": { | |
| "title": "Group", | |
| "required": [ | |
| "name", | |
| "slug" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "url": { | |
| "title": "Url", | |
| "type": "string", | |
| "format": "uri", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 50 | |
| }, | |
| "slug": { | |
| "title": "Slug", | |
| "type": "string", | |
| "format": "slug", | |
| "pattern": "^[-a-zA-Z0-9_]+$", | |
| "maxLength": 50 | |
| } | |
| } | |
| }, | |
| "Cluster": { | |
| "required": [ | |
| "name", | |
| "type", | |
| "group", | |
| "site" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 100 | |
| }, | |
| "type": { | |
| "$ref": "#/definitions/NestedClusterType" | |
| }, | |
| "group": { | |
| "$ref": "#/definitions/NestedClusterGroup" | |
| }, | |
| "site": { | |
| "$ref": "#/definitions/NestedSite" | |
| }, | |
| "comments": { | |
| "title": "Comments", | |
| "type": "string" | |
| }, | |
| "custom_fields": { | |
| "title": "Custom fields", | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "WritableCluster": { | |
| "required": [ | |
| "name", | |
| "type" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 100 | |
| }, | |
| "type": { | |
| "title": "Type", | |
| "type": "integer" | |
| }, | |
| "group": { | |
| "title": "Group", | |
| "type": "integer" | |
| }, | |
| "site": { | |
| "title": "Site", | |
| "type": "integer" | |
| }, | |
| "comments": { | |
| "title": "Comments", | |
| "type": "string" | |
| }, | |
| "custom_fields": { | |
| "title": "Custom fields", | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "VirtualMachineIPAddress": { | |
| "title": "Primary ip", | |
| "required": [ | |
| "address" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "url": { | |
| "title": "Url", | |
| "type": "string", | |
| "format": "uri", | |
| "readOnly": true | |
| }, | |
| "family": { | |
| "title": "Family", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "address": { | |
| "title": "Address", | |
| "description": "IPv4 or IPv6 address (with mask)", | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "VirtualMachine": { | |
| "required": [ | |
| "name", | |
| "status", | |
| "cluster", | |
| "role", | |
| "tenant", | |
| "platform", | |
| "primary_ip", | |
| "primary_ip4", | |
| "primary_ip6" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 64 | |
| }, | |
| "status": { | |
| "title": "Status", | |
| "type": "string" | |
| }, | |
| "cluster": { | |
| "$ref": "#/definitions/NestedCluster" | |
| }, | |
| "role": { | |
| "$ref": "#/definitions/NestedDeviceRole" | |
| }, | |
| "tenant": { | |
| "$ref": "#/definitions/NestedTenant" | |
| }, | |
| "platform": { | |
| "$ref": "#/definitions/NestedPlatform" | |
| }, | |
| "primary_ip": { | |
| "$ref": "#/definitions/VirtualMachineIPAddress" | |
| }, | |
| "primary_ip4": { | |
| "$ref": "#/definitions/VirtualMachineIPAddress" | |
| }, | |
| "primary_ip6": { | |
| "$ref": "#/definitions/VirtualMachineIPAddress" | |
| }, | |
| "vcpus": { | |
| "title": "VCPUs", | |
| "type": "integer", | |
| "maximum": 32767, | |
| "minimum": 0 | |
| }, | |
| "memory": { | |
| "title": "Memory (MB)", | |
| "type": "integer", | |
| "maximum": 2147483647, | |
| "minimum": 0 | |
| }, | |
| "disk": { | |
| "title": "Disk (GB)", | |
| "type": "integer", | |
| "maximum": 2147483647, | |
| "minimum": 0 | |
| }, | |
| "comments": { | |
| "title": "Comments", | |
| "type": "string" | |
| }, | |
| "custom_fields": { | |
| "title": "Custom fields", | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "WritableVirtualMachine": { | |
| "required": [ | |
| "name", | |
| "cluster" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "title": "ID", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "type": "string", | |
| "maxLength": 64 | |
| }, | |
| "status": { | |
| "title": "Status", | |
| "type": "string", | |
| "enum": [ | |
| 1, | |
| 0, | |
| 3 | |
| ] | |
| }, | |
| "cluster": { | |
| "title": "Cluster", | |
| "type": "integer" | |
| }, | |
| "role": { | |
| "title": "Role", | |
| "type": "integer" | |
| }, | |
| "tenant": { | |
| "title": "Tenant", | |
| "type": "integer" | |
| }, | |
| "platform": { | |
| "title": "Platform", | |
| "type": "integer" | |
| }, | |
| "primary_ip4": { | |
| "title": "Primary IPv4", | |
| "type": "integer" | |
| }, | |
| "primary_ip6": { | |
| "title": "Primary IPv6", | |
| "type": "integer" | |
| }, | |
| "vcpus": { | |
| "title": "VCPUs", | |
| "type": "integer", | |
| "maximum": 32767, | |
| "minimum": 0 | |
| }, | |
| "memory": { | |
| "title": "Memory (MB)", | |
| "type": "integer", | |
| "maximum": 2147483647, | |
| "minimum": 0 | |
| }, | |
| "disk": { | |
| "title": "Disk (GB)", | |
| "type": "integer", | |
| "maximum": 2147483647, | |
| "minimum": 0 | |
| }, | |
| "comments": { | |
| "title": "Comments", | |
| "type": "string" | |
| }, | |
| "custom_fields": { | |
| "title": "Custom fields", | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment