{
"openapi": "3.0.3",
"info": {
"title": "NetBox REST API",
"version": "4.4.0",
"license": {
"name": "Apache v2 License"
}
},
"paths": {
"/api/circuits/circuit-group-assignments/": {
"get": {
"operationId": "circuits_circuit_group_assignments_list",
"description": "Get a list of Circuit group assignment objects.",
"parameters": [
{
"in": "query",
"name": "circuit",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "circuit_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Circuit group (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Circuit group (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Circuit group (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Circuit group (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "member_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "member_id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "member_id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "member_id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "member_id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "member_id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "member_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "member_type",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "member_type__n",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "priority",
"schema": {
"type": "string",
"x-spec-enum-id": "ef3a31644cec7524",
"nullable": true,
"enum": [
"inactive",
"primary",
"secondary",
"tertiary"
]
},
"description": "* `primary` - Primary\n* `secondary` - Secondary\n* `tertiary` - Tertiary\n* `inactive` - Inactive"
},
{
"in": "query",
"name": "provider",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "virtual_circuit",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_circuit_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedCircuitGroupAssignmentList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "circuits_circuit_group_assignments_create",
"description": "Post a list of Circuit group assignment objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableCircuitGroupAssignmentRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableCircuitGroupAssignmentRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CircuitGroupAssignment"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "circuits_circuit_group_assignments_bulk_update",
"description": "Put a list of Circuit group assignment objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitGroupAssignmentRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitGroupAssignmentRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitGroupAssignment"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "circuits_circuit_group_assignments_bulk_partial_update",
"description": "Patch a list of Circuit group assignment objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitGroupAssignmentRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitGroupAssignmentRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitGroupAssignment"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "circuits_circuit_group_assignments_bulk_destroy",
"description": "Delete a list of Circuit group assignment objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitGroupAssignmentRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitGroupAssignmentRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/circuits/circuit-group-assignments/{id}/": {
"get": {
"operationId": "circuits_circuit_group_assignments_retrieve",
"description": "Get a Circuit group assignment object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this Circuit group assignment.",
"required": true
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CircuitGroupAssignment"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "circuits_circuit_group_assignments_update",
"description": "Put a Circuit group assignment object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this Circuit group assignment.",
"required": true
}
],
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableCircuitGroupAssignmentRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableCircuitGroupAssignmentRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CircuitGroupAssignment"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "circuits_circuit_group_assignments_partial_update",
"description": "Patch a Circuit group assignment object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this Circuit group assignment.",
"required": true
}
],
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableCircuitGroupAssignmentRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableCircuitGroupAssignmentRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CircuitGroupAssignment"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "circuits_circuit_group_assignments_destroy",
"description": "Delete a Circuit group assignment object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this Circuit group assignment.",
"required": true
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/circuits/circuit-groups/": {
"get": {
"operationId": "circuits_circuit_groups_list",
"description": "Get a list of circuit group objects.",
"parameters": [
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "slug",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "slug__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedCircuitGroupList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "circuits_circuit_groups_create",
"description": "Post a list of circuit group objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CircuitGroupRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/CircuitGroupRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CircuitGroup"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "circuits_circuit_groups_bulk_update",
"description": "Put a list of circuit group objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitGroupRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitGroupRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitGroup"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "circuits_circuit_groups_bulk_partial_update",
"description": "Patch a list of circuit group objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitGroupRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitGroupRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitGroup"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "circuits_circuit_groups_bulk_destroy",
"description": "Delete a list of circuit group objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitGroupRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitGroupRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/circuits/circuit-groups/{id}/": {
"get": {
"operationId": "circuits_circuit_groups_retrieve",
"description": "Get a circuit group object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this circuit group.",
"required": true
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CircuitGroup"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "circuits_circuit_groups_update",
"description": "Put a circuit group object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this circuit group.",
"required": true
}
],
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CircuitGroupRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/CircuitGroupRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CircuitGroup"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "circuits_circuit_groups_partial_update",
"description": "Patch a circuit group object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this circuit group.",
"required": true
}
],
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedCircuitGroupRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedCircuitGroupRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CircuitGroup"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "circuits_circuit_groups_destroy",
"description": "Delete a circuit group object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this circuit group.",
"required": true
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/circuits/circuit-terminations/": {
"get": {
"operationId": "circuits_circuit_terminations_list",
"description": "Get a list of circuit termination objects.",
"parameters": [
{
"in": "query",
"name": "cable_end",
"schema": {
"type": "string",
"x-spec-enum-id": "1db84f9b93b261c8",
"nullable": true,
"enum": [
"A",
"B"
]
},
"description": "* `A` - A\n* `B` - B"
},
{
"in": "query",
"name": "cable_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Cable (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cable_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Cable (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cabled",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "circuit_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Circuit",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "circuit_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Circuit",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "location",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mark_connected",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "occupied",
"schema": {
"type": "boolean"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "port_speed",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "port_speed__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "port_speed__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "port_speed__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "port_speed__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "port_speed__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "port_speed__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "pp_info",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "pp_info__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "pp_info__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "pp_info__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "pp_info__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "pp_info__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "pp_info__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "pp_info__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "pp_info__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "pp_info__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "pp_info__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "pp_info__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "pp_info__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Provider (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Provider (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Provider (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Provider (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider_network_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "ProviderNetwork (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider_network_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "ProviderNetwork (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "region",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "term_side",
"schema": {
"type": "string",
"x-spec-enum-id": "95b8fcc737f355d0",
"title": "Termination side",
"enum": [
"A",
"Z"
]
},
"description": "* `A` - A\n* `Z` - Z"
},
{
"in": "query",
"name": "termination_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "termination_id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "termination_id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "termination_id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "termination_id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "termination_id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "termination_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "termination_type",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "termination_type__n",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "upstream_speed",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "upstream_speed__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "upstream_speed__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "upstream_speed__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "upstream_speed__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "upstream_speed__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "upstream_speed__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "xconnect_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "xconnect_id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "xconnect_id__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "xconnect_id__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "xconnect_id__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "xconnect_id__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "xconnect_id__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "xconnect_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "xconnect_id__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "xconnect_id__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "xconnect_id__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "xconnect_id__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "xconnect_id__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedCircuitTerminationList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "circuits_circuit_terminations_create",
"description": "Post a list of circuit termination objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CircuitTerminationRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/CircuitTerminationRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CircuitTermination"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "circuits_circuit_terminations_bulk_update",
"description": "Put a list of circuit termination objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitTerminationRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitTerminationRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitTermination"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "circuits_circuit_terminations_bulk_partial_update",
"description": "Patch a list of circuit termination objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitTerminationRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitTerminationRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitTermination"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "circuits_circuit_terminations_bulk_destroy",
"description": "Delete a list of circuit termination objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitTerminationRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitTerminationRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/circuits/circuit-terminations/{id}/": {
"get": {
"operationId": "circuits_circuit_terminations_retrieve",
"description": "Get a circuit termination object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this circuit termination.",
"required": true
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CircuitTermination"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "circuits_circuit_terminations_update",
"description": "Put a circuit termination object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this circuit termination.",
"required": true
}
],
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CircuitTerminationRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/CircuitTerminationRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CircuitTermination"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "circuits_circuit_terminations_partial_update",
"description": "Patch a circuit termination object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this circuit termination.",
"required": true
}
],
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedCircuitTerminationRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedCircuitTerminationRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CircuitTermination"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "circuits_circuit_terminations_destroy",
"description": "Delete a circuit termination object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this circuit termination.",
"required": true
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/circuits/circuit-terminations/{id}/paths/": {
"get": {
"operationId": "circuits_circuit_terminations_paths_retrieve",
"description": "Return all CablePaths which traverse a given pass-through port.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this circuit termination.",
"required": true
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CircuitTermination"
}
}
},
"description": ""
}
}
}
},
"/api/circuits/circuit-types/": {
"get": {
"operationId": "circuits_circuit_types_list",
"description": "Get a list of circuit type objects.",
"parameters": [
{
"in": "query",
"name": "color",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "color__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "slug",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "slug__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedCircuitTypeList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "circuits_circuit_types_create",
"description": "Post a list of circuit type objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CircuitTypeRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/CircuitTypeRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CircuitType"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "circuits_circuit_types_bulk_update",
"description": "Put a list of circuit type objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitTypeRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitTypeRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitType"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "circuits_circuit_types_bulk_partial_update",
"description": "Patch a list of circuit type objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitTypeRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitTypeRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitType"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "circuits_circuit_types_bulk_destroy",
"description": "Delete a list of circuit type objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitTypeRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitTypeRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/circuits/circuit-types/{id}/": {
"get": {
"operationId": "circuits_circuit_types_retrieve",
"description": "Get a circuit type object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this circuit type.",
"required": true
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CircuitType"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "circuits_circuit_types_update",
"description": "Put a circuit type object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this circuit type.",
"required": true
}
],
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CircuitTypeRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/CircuitTypeRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CircuitType"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "circuits_circuit_types_partial_update",
"description": "Patch a circuit type object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this circuit type.",
"required": true
}
],
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedCircuitTypeRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedCircuitTypeRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CircuitType"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "circuits_circuit_types_destroy",
"description": "Delete a circuit type object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this circuit type.",
"required": true
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/circuits/circuits/": {
"get": {
"operationId": "circuits_circuits_list",
"description": "Get a list of circuit objects.",
"parameters": [
{
"in": "query",
"name": "cid",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cid__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "cid__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cid__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cid__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cid__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cid__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cid__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cid__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cid__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cid__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cid__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cid__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "commit_rate",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "commit_rate__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "commit_rate__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "commit_rate__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "commit_rate__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "commit_rate__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "commit_rate__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "distance",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "distance__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "distance__gt",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "distance__gte",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "distance__lt",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "distance__lte",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "distance__n",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "distance_unit",
"schema": {
"type": "string",
"x-spec-enum-id": "53542e7902f946af",
"nullable": true,
"enum": [
"ft",
"km",
"m",
"mi"
]
},
"description": "* `km` - Kilometers\n* `m` - Meters\n* `mi` - Miles\n* `ft` - Feet"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "install_date",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "install_date__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "install_date__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "install_date__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "install_date__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "install_date__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "install_date__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "location_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Location (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Location (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "provider",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Provider (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Provider (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider_account",
"schema": {
"type": "array",
"items": {
"type": "string",
"title": "Account ID"
}
},
"description": "Provider account (account)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider_account__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"title": "Account ID"
}
},
"description": "Provider account (account)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider_account_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Provider account (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider_account_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Provider account (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Provider (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Provider (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider_network_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Provider network (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider_network_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Provider network (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "region",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "63c838134a022200"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "status__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "63c838134a022200"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "63c838134a022200"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "63c838134a022200"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "63c838134a022200"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "63c838134a022200"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "63c838134a022200"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "63c838134a022200"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "63c838134a022200"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "63c838134a022200"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "63c838134a022200"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "63c838134a022200"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "termination_a_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Termination A (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "termination_a_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Termination A (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "termination_date",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "termination_date__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "termination_date__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "termination_date__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "termination_date__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "termination_date__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "termination_date__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "termination_z_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Termination A (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "termination_z_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Termination A (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Circuit type (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Circuit type (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Circuit type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Circuit type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedCircuitList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "circuits_circuits_create",
"description": "Post a list of circuit objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableCircuitRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableCircuitRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Circuit"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "circuits_circuits_bulk_update",
"description": "Put a list of circuit objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Circuit"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "circuits_circuits_bulk_partial_update",
"description": "Patch a list of circuit objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Circuit"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "circuits_circuits_bulk_destroy",
"description": "Delete a list of circuit objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/circuits/circuits/{id}/": {
"get": {
"operationId": "circuits_circuits_retrieve",
"description": "Get a circuit object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this circuit.",
"required": true
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Circuit"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "circuits_circuits_update",
"description": "Put a circuit object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this circuit.",
"required": true
}
],
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableCircuitRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableCircuitRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Circuit"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "circuits_circuits_partial_update",
"description": "Patch a circuit object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this circuit.",
"required": true
}
],
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableCircuitRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableCircuitRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Circuit"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "circuits_circuits_destroy",
"description": "Delete a circuit object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this circuit.",
"required": true
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/circuits/provider-accounts/": {
"get": {
"operationId": "circuits_provider_accounts_list",
"description": "Get a list of provider account objects.",
"parameters": [
{
"in": "query",
"name": "account",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "account__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "account__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "account__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "account__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "account__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "account__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "account__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "account__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "account__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "account__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "account__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "account__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "provider",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Provider (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Provider (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Provider (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Provider (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedProviderAccountList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "circuits_provider_accounts_create",
"description": "Post a list of provider account objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProviderAccountRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ProviderAccountRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProviderAccount"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "circuits_provider_accounts_bulk_update",
"description": "Put a list of provider account objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderAccountRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderAccountRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderAccount"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "circuits_provider_accounts_bulk_partial_update",
"description": "Patch a list of provider account objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderAccountRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderAccountRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderAccount"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "circuits_provider_accounts_bulk_destroy",
"description": "Delete a list of provider account objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderAccountRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderAccountRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/circuits/provider-accounts/{id}/": {
"get": {
"operationId": "circuits_provider_accounts_retrieve",
"description": "Get a provider account object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this provider account.",
"required": true
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProviderAccount"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "circuits_provider_accounts_update",
"description": "Put a provider account object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this provider account.",
"required": true
}
],
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProviderAccountRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ProviderAccountRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProviderAccount"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "circuits_provider_accounts_partial_update",
"description": "Patch a provider account object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this provider account.",
"required": true
}
],
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedProviderAccountRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedProviderAccountRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProviderAccount"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "circuits_provider_accounts_destroy",
"description": "Delete a provider account object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this provider account.",
"required": true
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/circuits/provider-networks/": {
"get": {
"operationId": "circuits_provider_networks_list",
"description": "Get a list of provider network objects.",
"parameters": [
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "provider",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Provider (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Provider (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Provider (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Provider (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "service_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "service_id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "service_id__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "service_id__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "service_id__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "service_id__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "service_id__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "service_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "service_id__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "service_id__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "service_id__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "service_id__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "service_id__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedProviderNetworkList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "circuits_provider_networks_create",
"description": "Post a list of provider network objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProviderNetworkRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ProviderNetworkRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProviderNetwork"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "circuits_provider_networks_bulk_update",
"description": "Put a list of provider network objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderNetworkRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderNetworkRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderNetwork"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "circuits_provider_networks_bulk_partial_update",
"description": "Patch a list of provider network objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderNetworkRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderNetworkRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderNetwork"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "circuits_provider_networks_bulk_destroy",
"description": "Delete a list of provider network objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderNetworkRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderNetworkRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/circuits/provider-networks/{id}/": {
"get": {
"operationId": "circuits_provider_networks_retrieve",
"description": "Get a provider network object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this provider network.",
"required": true
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProviderNetwork"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "circuits_provider_networks_update",
"description": "Put a provider network object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this provider network.",
"required": true
}
],
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProviderNetworkRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ProviderNetworkRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProviderNetwork"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "circuits_provider_networks_partial_update",
"description": "Patch a provider network object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this provider network.",
"required": true
}
],
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedProviderNetworkRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedProviderNetworkRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProviderNetwork"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "circuits_provider_networks_destroy",
"description": "Delete a provider network object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this provider network.",
"required": true
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/circuits/providers/": {
"get": {
"operationId": "circuits_providers_list",
"description": "Get a list of provider objects.",
"parameters": [
{
"in": "query",
"name": "asn",
"schema": {
"type": "array",
"items": {
"type": "integer",
"maximum": 4294967295,
"minimum": 1,
"format": "int64"
}
},
"description": "ASN",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asn__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"maximum": 4294967295,
"minimum": 1,
"format": "int64"
}
},
"description": "ASN",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asn_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "ASN (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asn_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "ASN (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "region",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "slug__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedProviderList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "circuits_providers_create",
"description": "Post a list of provider objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProviderRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ProviderRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Provider"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "circuits_providers_bulk_update",
"description": "Put a list of provider objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Provider"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "circuits_providers_bulk_partial_update",
"description": "Patch a list of provider objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Provider"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "circuits_providers_bulk_destroy",
"description": "Delete a list of provider objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/circuits/providers/{id}/": {
"get": {
"operationId": "circuits_providers_retrieve",
"description": "Get a provider object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this provider.",
"required": true
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Provider"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "circuits_providers_update",
"description": "Put a provider object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this provider.",
"required": true
}
],
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProviderRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ProviderRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Provider"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "circuits_providers_partial_update",
"description": "Patch a provider object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this provider.",
"required": true
}
],
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedProviderRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedProviderRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Provider"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "circuits_providers_destroy",
"description": "Delete a provider object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this provider.",
"required": true
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/circuits/virtual-circuit-terminations/": {
"get": {
"operationId": "circuits_virtual_circuit_terminations_list",
"description": "Get a list of virtual circuit termination objects.",
"parameters": [
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Interface (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Interface (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "provider",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Provider (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Provider (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider_account",
"schema": {
"type": "array",
"items": {
"type": "string",
"title": "Account ID"
}
},
"description": "Provider account (account)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider_account__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"title": "Account ID"
}
},
"description": "Provider account (account)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider_account_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Provider account (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider_account_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Provider account (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Provider (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Provider (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider_network_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Provider network (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider_network_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Provider network (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "role",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "52225cd60b867572"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "role__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "52225cd60b867572"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "52225cd60b867572"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "52225cd60b867572"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "52225cd60b867572"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "52225cd60b867572"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "52225cd60b867572"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "52225cd60b867572"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "52225cd60b867572"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "52225cd60b867572"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "52225cd60b867572"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "52225cd60b867572"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "virtual_circuit_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual circuit",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_circuit_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual circuit",
"explode": true,
"style": "form"
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedVirtualCircuitTerminationList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "circuits_virtual_circuit_terminations_create",
"description": "Post a list of virtual circuit termination objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableVirtualCircuitTerminationRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableVirtualCircuitTerminationRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualCircuitTermination"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "circuits_virtual_circuit_terminations_bulk_update",
"description": "Put a list of virtual circuit termination objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualCircuitTerminationRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualCircuitTerminationRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualCircuitTermination"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "circuits_virtual_circuit_terminations_bulk_partial_update",
"description": "Patch a list of virtual circuit termination objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualCircuitTerminationRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualCircuitTerminationRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualCircuitTermination"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "circuits_virtual_circuit_terminations_bulk_destroy",
"description": "Delete a list of virtual circuit termination objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualCircuitTerminationRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualCircuitTerminationRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/circuits/virtual-circuit-terminations/{id}/": {
"get": {
"operationId": "circuits_virtual_circuit_terminations_retrieve",
"description": "Get a virtual circuit termination object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this virtual circuit termination.",
"required": true
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualCircuitTermination"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "circuits_virtual_circuit_terminations_update",
"description": "Put a virtual circuit termination object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this virtual circuit termination.",
"required": true
}
],
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableVirtualCircuitTerminationRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableVirtualCircuitTerminationRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualCircuitTermination"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "circuits_virtual_circuit_terminations_partial_update",
"description": "Patch a virtual circuit termination object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this virtual circuit termination.",
"required": true
}
],
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableVirtualCircuitTerminationRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableVirtualCircuitTerminationRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualCircuitTermination"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "circuits_virtual_circuit_terminations_destroy",
"description": "Delete a virtual circuit termination object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this virtual circuit termination.",
"required": true
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/circuits/virtual-circuit-terminations/{id}/paths/": {
"get": {
"operationId": "circuits_virtual_circuit_terminations_paths_retrieve",
"description": "Return all CablePaths which traverse a given pass-through port.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this virtual circuit termination.",
"required": true
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualCircuitTermination"
}
}
},
"description": ""
}
}
}
},
"/api/circuits/virtual-circuit-types/": {
"get": {
"operationId": "circuits_virtual_circuit_types_list",
"description": "Get a list of virtual circuit type objects.",
"parameters": [
{
"in": "query",
"name": "color",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "color__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "slug",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "slug__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedVirtualCircuitTypeList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "circuits_virtual_circuit_types_create",
"description": "Post a list of virtual circuit type objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualCircuitTypeRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/VirtualCircuitTypeRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualCircuitType"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "circuits_virtual_circuit_types_bulk_update",
"description": "Put a list of virtual circuit type objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualCircuitTypeRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualCircuitTypeRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualCircuitType"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "circuits_virtual_circuit_types_bulk_partial_update",
"description": "Patch a list of virtual circuit type objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualCircuitTypeRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualCircuitTypeRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualCircuitType"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "circuits_virtual_circuit_types_bulk_destroy",
"description": "Delete a list of virtual circuit type objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualCircuitTypeRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualCircuitTypeRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/circuits/virtual-circuit-types/{id}/": {
"get": {
"operationId": "circuits_virtual_circuit_types_retrieve",
"description": "Get a virtual circuit type object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this virtual circuit type.",
"required": true
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualCircuitType"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "circuits_virtual_circuit_types_update",
"description": "Put a virtual circuit type object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this virtual circuit type.",
"required": true
}
],
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualCircuitTypeRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/VirtualCircuitTypeRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualCircuitType"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "circuits_virtual_circuit_types_partial_update",
"description": "Patch a virtual circuit type object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this virtual circuit type.",
"required": true
}
],
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedVirtualCircuitTypeRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedVirtualCircuitTypeRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualCircuitType"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "circuits_virtual_circuit_types_destroy",
"description": "Delete a virtual circuit type object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this virtual circuit type.",
"required": true
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/circuits/virtual-circuits/": {
"get": {
"operationId": "circuits_virtual_circuits_list",
"description": "Get a list of virtual circuit objects.",
"parameters": [
{
"in": "query",
"name": "cid",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cid__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "cid__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cid__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cid__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cid__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cid__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cid__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cid__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cid__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cid__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cid__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cid__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "provider",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Provider (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Provider (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider_account",
"schema": {
"type": "array",
"items": {
"type": "string",
"title": "Account ID"
}
},
"description": "Provider account (account)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider_account__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"title": "Account ID"
}
},
"description": "Provider account (account)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider_account_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Provider account (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider_account_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Provider account (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Provider (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Provider (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider_network_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Provider network (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider_network_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Provider network (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "status",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "63c838134a022200"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "status__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "63c838134a022200"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "63c838134a022200"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "63c838134a022200"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "63c838134a022200"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "63c838134a022200"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "63c838134a022200"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "63c838134a022200"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "63c838134a022200"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "63c838134a022200"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "63c838134a022200"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "63c838134a022200"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Virtual circuit type (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Virtual circuit type (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual circuit type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual circuit type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedVirtualCircuitList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "circuits_virtual_circuits_create",
"description": "Post a list of virtual circuit objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableVirtualCircuitRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableVirtualCircuitRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualCircuit"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "circuits_virtual_circuits_bulk_update",
"description": "Put a list of virtual circuit objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualCircuitRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualCircuitRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualCircuit"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "circuits_virtual_circuits_bulk_partial_update",
"description": "Patch a list of virtual circuit objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualCircuitRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualCircuitRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualCircuit"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "circuits_virtual_circuits_bulk_destroy",
"description": "Delete a list of virtual circuit objects.",
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualCircuitRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualCircuitRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/circuits/virtual-circuits/{id}/": {
"get": {
"operationId": "circuits_virtual_circuits_retrieve",
"description": "Get a virtual circuit object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this virtual circuit.",
"required": true
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualCircuit"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "circuits_virtual_circuits_update",
"description": "Put a virtual circuit object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this virtual circuit.",
"required": true
}
],
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableVirtualCircuitRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableVirtualCircuitRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualCircuit"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "circuits_virtual_circuits_partial_update",
"description": "Patch a virtual circuit object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this virtual circuit.",
"required": true
}
],
"tags": [
"circuits"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableVirtualCircuitRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableVirtualCircuitRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualCircuit"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "circuits_virtual_circuits_destroy",
"description": "Delete a virtual circuit object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this virtual circuit.",
"required": true
}
],
"tags": [
"circuits"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/core/background-queues/": {
"get": {
"operationId": "core_background_queues_retrieve",
"description": "Retrieve a list of RQ Queues.\nNote: Queue names are not URL safe so not returning a detail view.",
"tags": [
"core"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {}
}
}
},
"description": ""
}
}
}
},
"/api/core/background-queues/{name}/": {
"get": {
"operationId": "core_background_queues_retrieve_2",
"description": "Retrieve a list of RQ Queues.\nNote: Queue names are not URL safe so not returning a detail view.",
"parameters": [
{
"in": "path",
"name": "name",
"schema": {
"type": "string",
"pattern": "^[\\w.@+-]+$"
},
"required": true
}
],
"tags": [
"core"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {}
}
}
},
"description": ""
}
}
}
},
"/api/core/background-tasks/": {
"get": {
"operationId": "core_background_tasks_retrieve",
"description": "Retrieve a list of RQ Tasks.",
"tags": [
"core"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {}
}
}
},
"description": ""
}
}
}
},
"/api/core/background-tasks/{id}/": {
"get": {
"operationId": "core_background_tasks_retrieve_2",
"description": "Retrieve a list of RQ Tasks.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string"
},
"required": true
}
],
"tags": [
"core"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {}
}
}
},
"description": ""
}
}
}
},
"/api/core/background-tasks/{id}/delete/": {
"post": {
"operationId": "core_background_tasks_delete_create",
"description": "Retrieve a list of RQ Tasks.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string"
},
"required": true
}
],
"tags": [
"core"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/core/background-tasks/{id}/enqueue/": {
"post": {
"operationId": "core_background_tasks_enqueue_create",
"description": "Retrieve a list of RQ Tasks.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string"
},
"required": true
}
],
"tags": [
"core"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/core/background-tasks/{id}/requeue/": {
"post": {
"operationId": "core_background_tasks_requeue_create",
"description": "Retrieve a list of RQ Tasks.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string"
},
"required": true
}
],
"tags": [
"core"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/core/background-tasks/{id}/stop/": {
"post": {
"operationId": "core_background_tasks_stop_create",
"description": "Retrieve a list of RQ Tasks.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string"
},
"required": true
}
],
"tags": [
"core"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/core/background-workers/": {
"get": {
"operationId": "core_background_workers_retrieve",
"description": "Retrieve a list of RQ Workers.",
"tags": [
"core"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {}
}
}
},
"description": ""
}
}
}
},
"/api/core/background-workers/{name}/": {
"get": {
"operationId": "core_background_workers_retrieve_2",
"description": "Retrieve a list of RQ Workers.",
"parameters": [
{
"in": "path",
"name": "name",
"schema": {
"type": "string"
},
"required": true
}
],
"tags": [
"core"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/core/data-files/": {
"get": {
"operationId": "core_data_files_list",
"description": "Get a list of data file objects.",
"parameters": [
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "hash",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "hash__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "hash__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "hash__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "hash__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "hash__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "hash__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "hash__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "hash__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "hash__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "hash__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "hash__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "hash__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "path",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "path__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "path__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "path__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "path__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "path__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "path__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "path__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "path__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "path__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "path__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "path__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "path__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "size",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "size__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "size__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "size__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "size__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "size__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "size__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "source",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Data source (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "source__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Data source (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "source_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Data source (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "source_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Data source (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"core"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedDataFileList"
}
}
},
"description": ""
}
}
}
},
"/api/core/data-files/{id}/": {
"get": {
"operationId": "core_data_files_retrieve",
"description": "Get a data file object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this data file.",
"required": true
}
],
"tags": [
"core"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataFile"
}
}
},
"description": ""
}
}
}
},
"/api/core/data-sources/": {
"get": {
"operationId": "core_data_sources_list",
"description": "Get a list of data source objects.",
"parameters": [
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "enabled",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_synced",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_synced__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "last_synced__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_synced__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_synced__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_synced__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_synced__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "source_url",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "source_url__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "source_url__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "source_url__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "source_url__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "source_url__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "source_url__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "source_url__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "source_url__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "source_url__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "source_url__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "source_url__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "source_url__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "status__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "sync_interval",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "2e9f2567ecd93fbe",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "sync_interval__ic",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "2e9f2567ecd93fbe",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "sync_interval__ie",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "2e9f2567ecd93fbe",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "sync_interval__iew",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "2e9f2567ecd93fbe",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "sync_interval__iregex",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "2e9f2567ecd93fbe",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "sync_interval__isw",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "2e9f2567ecd93fbe",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "sync_interval__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "2e9f2567ecd93fbe",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "sync_interval__nic",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "2e9f2567ecd93fbe",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "sync_interval__nie",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "2e9f2567ecd93fbe",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "sync_interval__niew",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "2e9f2567ecd93fbe",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "sync_interval__nisw",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "2e9f2567ecd93fbe",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "sync_interval__regex",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "2e9f2567ecd93fbe",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "type__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"core"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedDataSourceList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "core_data_sources_create",
"description": "Post a list of data source objects.",
"tags": [
"core"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableDataSourceRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableDataSourceRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataSource"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "core_data_sources_bulk_update",
"description": "Put a list of data source objects.",
"tags": [
"core"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataSourceRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataSourceRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataSource"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "core_data_sources_bulk_partial_update",
"description": "Patch a list of data source objects.",
"tags": [
"core"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataSourceRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataSourceRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataSource"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "core_data_sources_bulk_destroy",
"description": "Delete a list of data source objects.",
"tags": [
"core"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataSourceRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataSourceRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/core/data-sources/{id}/": {
"get": {
"operationId": "core_data_sources_retrieve",
"description": "Get a data source object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this data source.",
"required": true
}
],
"tags": [
"core"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataSource"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "core_data_sources_update",
"description": "Put a data source object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this data source.",
"required": true
}
],
"tags": [
"core"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableDataSourceRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableDataSourceRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataSource"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "core_data_sources_partial_update",
"description": "Patch a data source object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this data source.",
"required": true
}
],
"tags": [
"core"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableDataSourceRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableDataSourceRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataSource"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "core_data_sources_destroy",
"description": "Delete a data source object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this data source.",
"required": true
}
],
"tags": [
"core"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/core/data-sources/{id}/sync/": {
"post": {
"operationId": "core_data_sources_sync_create",
"description": "Enqueue a job to synchronize the DataSource.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this data source.",
"required": true
}
],
"tags": [
"core"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableDataSourceRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableDataSourceRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataSource"
}
}
},
"description": ""
}
}
}
},
"/api/core/jobs/": {
"get": {
"operationId": "core_jobs_list",
"description": "Retrieve a list of job results",
"parameters": [
{
"in": "query",
"name": "completed",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"in": "query",
"name": "completed__after",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"in": "query",
"name": "completed__before",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"in": "query",
"name": "created",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"in": "query",
"name": "created__after",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"in": "query",
"name": "created__before",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interval",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interval__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "interval__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interval__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interval__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interval__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interval__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "job_id",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "object_id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_type",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "object_type__n",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "scheduled",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"in": "query",
"name": "scheduled__after",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"in": "query",
"name": "scheduled__before",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"in": "query",
"name": "started",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"in": "query",
"name": "started__after",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"in": "query",
"name": "started__before",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"in": "query",
"name": "status",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e33887d83efcc138"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "status__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e33887d83efcc138"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e33887d83efcc138"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e33887d83efcc138"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e33887d83efcc138"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e33887d83efcc138"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e33887d83efcc138"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e33887d83efcc138"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e33887d83efcc138"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e33887d83efcc138"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e33887d83efcc138"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e33887d83efcc138"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "user",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "user__n",
"schema": {
"type": "integer"
}
}
],
"tags": [
"core"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedJobList"
}
}
},
"description": ""
}
}
}
},
"/api/core/jobs/{id}/": {
"get": {
"operationId": "core_jobs_retrieve",
"description": "Retrieve a list of job results",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this job.",
"required": true
}
],
"tags": [
"core"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Job"
}
}
},
"description": ""
}
}
}
},
"/api/core/object-changes/": {
"get": {
"operationId": "core_object_changes_list",
"description": "Retrieve a list of recent changes.",
"parameters": [
{
"in": "query",
"name": "action",
"schema": {
"type": "string",
"x-spec-enum-id": "544f9b3b28b7ce6a",
"enum": [
"create",
"delete",
"update"
]
},
"description": "* `create` - Created\n* `update` - Updated\n* `delete` - Deleted"
},
{
"in": "query",
"name": "changed_object_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "changed_object_id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "changed_object_id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "changed_object_id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "changed_object_id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "changed_object_id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "changed_object_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "changed_object_type",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "changed_object_type__n",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "changed_object_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "changed_object_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "object_repr",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_repr__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "object_repr__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_repr__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_repr__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_repr__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_repr__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_repr__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_repr__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_repr__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_repr__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_repr__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_repr__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "related_object_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "related_object_id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "related_object_id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "related_object_id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "related_object_id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "related_object_id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "related_object_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "related_object_type",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "related_object_type__n",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "request_id",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "time_after",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"in": "query",
"name": "time_before",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"in": "query",
"name": "user",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "User name",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "user__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "User name",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "user_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "User (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "user_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "User (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "user_name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "user_name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "user_name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "user_name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "user_name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "user_name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "user_name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "user_name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "user_name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "user_name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "user_name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "user_name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "user_name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
}
],
"tags": [
"core"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedObjectChangeList"
}
}
},
"description": ""
}
}
}
},
"/api/core/object-changes/{id}/": {
"get": {
"operationId": "core_object_changes_retrieve",
"description": "Retrieve a list of recent changes.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this object change.",
"required": true
}
],
"tags": [
"core"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectChange"
}
}
},
"description": ""
}
}
}
},
"/api/core/object-types/": {
"get": {
"operationId": "core_object_types_list",
"description": "Read-only list of ObjectTypes.",
"parameters": [
{
"in": "query",
"name": "app_label",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "app_label__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "app_label__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "app_label__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "app_label__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "app_label__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "app_label__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "app_label__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "app_label__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "app_label__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "app_label__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "app_label__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "app_label__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "features",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "model",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "model__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "public",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
}
],
"tags": [
"core"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedObjectTypeList"
}
}
},
"description": ""
}
}
}
},
"/api/core/object-types/{id}/": {
"get": {
"operationId": "core_object_types_retrieve",
"description": "Read-only list of ObjectTypes.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this object type.",
"required": true
}
],
"tags": [
"core"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectType"
}
}
},
"description": ""
}
}
}
},
"/api/dcim/cable-terminations/": {
"get": {
"operationId": "dcim_cable_terminations_list",
"description": "Get a list of cable termination objects.",
"parameters": [
{
"in": "query",
"name": "cable",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "cable__n",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "cable_end",
"schema": {
"type": "string",
"x-spec-enum-id": "1db84f9b93b261c8",
"title": "End",
"enum": [
"A",
"B"
]
},
"description": "* `A` - A\n* `B` - B"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "termination_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "termination_id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "termination_id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "termination_id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "termination_id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "termination_id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "termination_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "termination_type",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "termination_type__n",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedCableTerminationList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_cable_terminations_create",
"description": "Post a list of cable termination objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CableTerminationRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/CableTerminationRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CableTermination"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_cable_terminations_bulk_update",
"description": "Put a list of cable termination objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CableTerminationRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CableTerminationRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CableTermination"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_cable_terminations_bulk_partial_update",
"description": "Patch a list of cable termination objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CableTerminationRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CableTerminationRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CableTermination"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_cable_terminations_bulk_destroy",
"description": "Delete a list of cable termination objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CableTerminationRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CableTerminationRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/cable-terminations/{id}/": {
"get": {
"operationId": "dcim_cable_terminations_retrieve",
"description": "Get a cable termination object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this cable termination.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CableTermination"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_cable_terminations_update",
"description": "Put a cable termination object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this cable termination.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CableTerminationRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/CableTerminationRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CableTermination"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_cable_terminations_partial_update",
"description": "Patch a cable termination object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this cable termination.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedCableTerminationRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedCableTerminationRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CableTermination"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_cable_terminations_destroy",
"description": "Delete a cable termination object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this cable termination.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/cables/": {
"get": {
"operationId": "dcim_cables_list",
"description": "Get a list of cable objects.",
"parameters": [
{
"in": "query",
"name": "circuittermination_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "color__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "consoleport_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "consoleserverport_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "frontport_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "label__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "length",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "length__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "length__gt",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "length__gte",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "length__lt",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "length__lte",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "length__n",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "length_unit",
"schema": {
"type": "string",
"x-spec-enum-id": "e64ce3a2c5997172",
"nullable": true,
"enum": [
"cm",
"ft",
"in",
"km",
"m",
"mi"
]
},
"description": "* `km` - Kilometers\n* `m` - Meters\n* `cm` - Centimeters\n* `mi` - Miles\n* `ft` - Feet\n* `in` - Inches"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "location",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "powerfeed_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poweroutlet_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "powerport_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "rack",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rearport_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "fbc2f302c08be50d"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "status__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "fbc2f302c08be50d"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "fbc2f302c08be50d"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "fbc2f302c08be50d"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "fbc2f302c08be50d"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "fbc2f302c08be50d"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "fbc2f302c08be50d"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "fbc2f302c08be50d"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "fbc2f302c08be50d"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "fbc2f302c08be50d"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "fbc2f302c08be50d"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "fbc2f302c08be50d"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "termination_a_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "termination_a_type",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "termination_a_type__n",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "termination_b_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "termination_b_type",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "termination_b_type__n",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "type",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "7b11d524b2b1a7ef",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "type__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "7b11d524b2b1a7ef",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "7b11d524b2b1a7ef",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "7b11d524b2b1a7ef",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "7b11d524b2b1a7ef",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "7b11d524b2b1a7ef",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "7b11d524b2b1a7ef",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "7b11d524b2b1a7ef",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "7b11d524b2b1a7ef",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "7b11d524b2b1a7ef",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "7b11d524b2b1a7ef",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "7b11d524b2b1a7ef",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "unterminated",
"schema": {
"type": "boolean"
},
"description": "Unterminated"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedCableList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_cables_create",
"description": "Post a list of cable objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableCableRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableCableRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Cable"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_cables_bulk_update",
"description": "Put a list of cable objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CableRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CableRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Cable"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_cables_bulk_partial_update",
"description": "Patch a list of cable objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CableRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CableRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Cable"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_cables_bulk_destroy",
"description": "Delete a list of cable objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CableRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CableRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/cables/{id}/": {
"get": {
"operationId": "dcim_cables_retrieve",
"description": "Get a cable object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this cable.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Cable"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_cables_update",
"description": "Put a cable object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this cable.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableCableRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableCableRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Cable"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_cables_partial_update",
"description": "Patch a cable object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this cable.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableCableRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableCableRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Cable"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_cables_destroy",
"description": "Delete a cable object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this cable.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/connected-device/": {
"get": {
"operationId": "dcim_connected_device_list",
"description": "This endpoint allows a user to determine what device (if any) is connected to a given peer device and peer\ninterface. This is useful in a situation where a device boots with no configuration, but can detect its neighbors\nvia a protocol such as LLDP. Two query parameters must be included in the request:\n\n* `peer_device`: The name of the peer device\n* `peer_interface`: The name of the peer interface",
"parameters": [
{
"in": "query",
"name": "peer_device",
"schema": {
"type": "string"
},
"description": "The name of the peer device",
"required": true
},
{
"in": "query",
"name": "peer_interface",
"schema": {
"type": "string"
},
"description": "The name of the peer interface",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Device"
}
}
}
},
"description": ""
}
}
}
},
"/api/dcim/console-port-templates/": {
"get": {
"operationId": "dcim_console_port_templates_list",
"description": "Get a list of console port template objects.",
"parameters": [
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "label__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "module_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Module type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "module_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Module type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "type",
"schema": {
"type": "string",
"x-spec-enum-id": "c5f7197b7211818a",
"nullable": true,
"enum": [
"Other",
"Serial",
"USB"
]
},
"description": "* `Serial` - [('de-9', 'DE-9'), ('db-25', 'DB-25'), ('rj-11', 'RJ-11'), ('rj-12', 'RJ-12'), ('rj-45', 'RJ-45'), ('mini-din-8', 'Mini-DIN 8')]\n* `USB` - [('usb-a', 'USB Type A'), ('usb-b', 'USB Type B'), ('usb-c', 'USB Type C'), ('usb-mini-a', 'USB Mini A'), ('usb-mini-b', 'USB Mini B'), ('usb-micro-a', 'USB Micro A'), ('usb-micro-b', 'USB Micro B'), ('usb-micro-ab', 'USB Micro AB')]\n* `Other` - [('other', 'Other')]"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedConsolePortTemplateList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_console_port_templates_create",
"description": "Post a list of console port template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableConsolePortTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableConsolePortTemplateRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsolePortTemplate"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_console_port_templates_bulk_update",
"description": "Put a list of console port template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsolePortTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsolePortTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsolePortTemplate"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_console_port_templates_bulk_partial_update",
"description": "Patch a list of console port template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsolePortTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsolePortTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsolePortTemplate"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_console_port_templates_bulk_destroy",
"description": "Delete a list of console port template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsolePortTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsolePortTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/console-port-templates/{id}/": {
"get": {
"operationId": "dcim_console_port_templates_retrieve",
"description": "Get a console port template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this console port template.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsolePortTemplate"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_console_port_templates_update",
"description": "Put a console port template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this console port template.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableConsolePortTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableConsolePortTemplateRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsolePortTemplate"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_console_port_templates_partial_update",
"description": "Patch a console port template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this console port template.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableConsolePortTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableConsolePortTemplateRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsolePortTemplate"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_console_port_templates_destroy",
"description": "Delete a console port template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this console port template.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/console-ports/": {
"get": {
"operationId": "dcim_console_ports_list",
"description": "Get a list of console port objects.",
"parameters": [
{
"in": "query",
"name": "cable_end",
"schema": {
"type": "string",
"x-spec-enum-id": "1db84f9b93b261c8",
"nullable": true,
"enum": [
"A",
"B"
]
},
"description": "* `A` - A\n* `B` - B"
},
{
"in": "query",
"name": "cable_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Cable (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cable_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Cable (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cabled",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "connected",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
},
"description": "Device (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
},
"description": "Device (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "device_status__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device type (model)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device type (model)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "label__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "location",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Location (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Location (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Location (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Location (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mark_connected",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "module_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Module (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "module_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Module (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "occupied",
"schema": {
"type": "boolean"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "rack",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Rack (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Rack (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Rack (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Rack (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site name (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site name (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "speed",
"schema": {
"type": "integer",
"x-spec-enum-id": "ab6d9635c131a378",
"nullable": true,
"enum": [
115200,
1200,
19200,
2400,
38400,
4800,
57600,
9600
]
},
"description": "Port speed in bits per second\n\n* `1200` - 1200 bps\n* `2400` - 2400 bps\n* `4800` - 4800 bps\n* `9600` - 9600 bps\n* `19200` - 19.2 kbps\n* `38400` - 38.4 kbps\n* `57600` - 57.6 kbps\n* `115200` - 115.2 kbps"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "c5f7197b7211818a",
"nullable": true
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "type__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "c5f7197b7211818a",
"nullable": true
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "c5f7197b7211818a",
"nullable": true
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "c5f7197b7211818a",
"nullable": true
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "c5f7197b7211818a",
"nullable": true
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "c5f7197b7211818a",
"nullable": true
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "c5f7197b7211818a",
"nullable": true
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "c5f7197b7211818a",
"nullable": true
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "c5f7197b7211818a",
"nullable": true
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "c5f7197b7211818a",
"nullable": true
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "c5f7197b7211818a",
"nullable": true
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "c5f7197b7211818a",
"nullable": true
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "virtual_chassis",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Virtual Chassis",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Virtual Chassis",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual Chassis (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual Chassis (ID)",
"explode": true,
"style": "form"
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedConsolePortList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_console_ports_create",
"description": "Post a list of console port objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableConsolePortRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableConsolePortRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsolePort"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_console_ports_bulk_update",
"description": "Put a list of console port objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsolePortRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsolePortRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsolePort"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_console_ports_bulk_partial_update",
"description": "Patch a list of console port objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsolePortRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsolePortRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsolePort"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_console_ports_bulk_destroy",
"description": "Delete a list of console port objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsolePortRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsolePortRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/console-ports/{id}/": {
"get": {
"operationId": "dcim_console_ports_retrieve",
"description": "Get a console port object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this console port.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsolePort"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_console_ports_update",
"description": "Put a console port object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this console port.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableConsolePortRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableConsolePortRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsolePort"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_console_ports_partial_update",
"description": "Patch a console port object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this console port.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableConsolePortRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableConsolePortRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsolePort"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_console_ports_destroy",
"description": "Delete a console port object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this console port.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/console-ports/{id}/trace/": {
"get": {
"operationId": "dcim_console_ports_trace_retrieve",
"description": "Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this console port.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsolePort"
}
}
},
"description": ""
}
}
}
},
"/api/dcim/console-server-port-templates/": {
"get": {
"operationId": "dcim_console_server_port_templates_list",
"description": "Get a list of console server port template objects.",
"parameters": [
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "label__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "module_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Module type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "module_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Module type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "type",
"schema": {
"type": "string",
"x-spec-enum-id": "c5f7197b7211818a",
"nullable": true,
"enum": [
"Other",
"Serial",
"USB"
]
},
"description": "* `Serial` - [('de-9', 'DE-9'), ('db-25', 'DB-25'), ('rj-11', 'RJ-11'), ('rj-12', 'RJ-12'), ('rj-45', 'RJ-45'), ('mini-din-8', 'Mini-DIN 8')]\n* `USB` - [('usb-a', 'USB Type A'), ('usb-b', 'USB Type B'), ('usb-c', 'USB Type C'), ('usb-mini-a', 'USB Mini A'), ('usb-mini-b', 'USB Mini B'), ('usb-micro-a', 'USB Micro A'), ('usb-micro-b', 'USB Micro B'), ('usb-micro-ab', 'USB Micro AB')]\n* `Other` - [('other', 'Other')]"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedConsoleServerPortTemplateList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_console_server_port_templates_create",
"description": "Post a list of console server port template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableConsoleServerPortTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableConsoleServerPortTemplateRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsoleServerPortTemplate"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_console_server_port_templates_bulk_update",
"description": "Put a list of console server port template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsoleServerPortTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsoleServerPortTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsoleServerPortTemplate"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_console_server_port_templates_bulk_partial_update",
"description": "Patch a list of console server port template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsoleServerPortTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsoleServerPortTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsoleServerPortTemplate"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_console_server_port_templates_bulk_destroy",
"description": "Delete a list of console server port template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsoleServerPortTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsoleServerPortTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/console-server-port-templates/{id}/": {
"get": {
"operationId": "dcim_console_server_port_templates_retrieve",
"description": "Get a console server port template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this console server port template.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsoleServerPortTemplate"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_console_server_port_templates_update",
"description": "Put a console server port template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this console server port template.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableConsoleServerPortTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableConsoleServerPortTemplateRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsoleServerPortTemplate"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_console_server_port_templates_partial_update",
"description": "Patch a console server port template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this console server port template.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableConsoleServerPortTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableConsoleServerPortTemplateRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsoleServerPortTemplate"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_console_server_port_templates_destroy",
"description": "Delete a console server port template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this console server port template.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/console-server-ports/": {
"get": {
"operationId": "dcim_console_server_ports_list",
"description": "Get a list of console server port objects.",
"parameters": [
{
"in": "query",
"name": "cable_end",
"schema": {
"type": "string",
"x-spec-enum-id": "1db84f9b93b261c8",
"nullable": true,
"enum": [
"A",
"B"
]
},
"description": "* `A` - A\n* `B` - B"
},
{
"in": "query",
"name": "cable_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Cable (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cable_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Cable (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cabled",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "connected",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
},
"description": "Device (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
},
"description": "Device (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "device_status__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device type (model)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device type (model)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "label__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "location",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Location (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Location (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Location (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Location (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mark_connected",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "module_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Module (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "module_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Module (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "occupied",
"schema": {
"type": "boolean"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "rack",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Rack (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Rack (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Rack (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Rack (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site name (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site name (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "speed",
"schema": {
"type": "integer",
"x-spec-enum-id": "ab6d9635c131a378",
"nullable": true,
"enum": [
115200,
1200,
19200,
2400,
38400,
4800,
57600,
9600
]
},
"description": "Port speed in bits per second\n\n* `1200` - 1200 bps\n* `2400` - 2400 bps\n* `4800` - 4800 bps\n* `9600` - 9600 bps\n* `19200` - 19.2 kbps\n* `38400` - 38.4 kbps\n* `57600` - 57.6 kbps\n* `115200` - 115.2 kbps"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "c5f7197b7211818a",
"nullable": true
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "type__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "c5f7197b7211818a",
"nullable": true
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "c5f7197b7211818a",
"nullable": true
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "c5f7197b7211818a",
"nullable": true
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "c5f7197b7211818a",
"nullable": true
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "c5f7197b7211818a",
"nullable": true
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "c5f7197b7211818a",
"nullable": true
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "c5f7197b7211818a",
"nullable": true
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "c5f7197b7211818a",
"nullable": true
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "c5f7197b7211818a",
"nullable": true
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "c5f7197b7211818a",
"nullable": true
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "c5f7197b7211818a",
"nullable": true
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "virtual_chassis",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Virtual Chassis",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Virtual Chassis",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual Chassis (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual Chassis (ID)",
"explode": true,
"style": "form"
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedConsoleServerPortList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_console_server_ports_create",
"description": "Post a list of console server port objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableConsoleServerPortRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableConsoleServerPortRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsoleServerPort"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_console_server_ports_bulk_update",
"description": "Put a list of console server port objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsoleServerPortRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsoleServerPortRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsoleServerPort"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_console_server_ports_bulk_partial_update",
"description": "Patch a list of console server port objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsoleServerPortRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsoleServerPortRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsoleServerPort"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_console_server_ports_bulk_destroy",
"description": "Delete a list of console server port objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsoleServerPortRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsoleServerPortRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/console-server-ports/{id}/": {
"get": {
"operationId": "dcim_console_server_ports_retrieve",
"description": "Get a console server port object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this console server port.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsoleServerPort"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_console_server_ports_update",
"description": "Put a console server port object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this console server port.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableConsoleServerPortRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableConsoleServerPortRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsoleServerPort"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_console_server_ports_partial_update",
"description": "Patch a console server port object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this console server port.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableConsoleServerPortRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableConsoleServerPortRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsoleServerPort"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_console_server_ports_destroy",
"description": "Delete a console server port object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this console server port.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/console-server-ports/{id}/trace/": {
"get": {
"operationId": "dcim_console_server_ports_trace_retrieve",
"description": "Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this console server port.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsoleServerPort"
}
}
},
"description": ""
}
}
}
},
"/api/dcim/device-bay-templates/": {
"get": {
"operationId": "dcim_device_bay_templates_list",
"description": "Get a list of device bay template objects.",
"parameters": [
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "label__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedDeviceBayTemplateList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_device_bay_templates_create",
"description": "Post a list of device bay template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceBayTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/DeviceBayTemplateRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceBayTemplate"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_device_bay_templates_bulk_update",
"description": "Put a list of device bay template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceBayTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceBayTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceBayTemplate"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_device_bay_templates_bulk_partial_update",
"description": "Patch a list of device bay template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceBayTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceBayTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceBayTemplate"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_device_bay_templates_bulk_destroy",
"description": "Delete a list of device bay template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceBayTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceBayTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/device-bay-templates/{id}/": {
"get": {
"operationId": "dcim_device_bay_templates_retrieve",
"description": "Get a device bay template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this device bay template.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceBayTemplate"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_device_bay_templates_update",
"description": "Put a device bay template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this device bay template.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceBayTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/DeviceBayTemplateRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceBayTemplate"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_device_bay_templates_partial_update",
"description": "Patch a device bay template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this device bay template.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedDeviceBayTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedDeviceBayTemplateRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceBayTemplate"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_device_bay_templates_destroy",
"description": "Delete a device bay template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this device bay template.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/device-bays/": {
"get": {
"operationId": "dcim_device_bays_list",
"description": "Get a list of device bay objects.",
"parameters": [
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
},
"description": "Device (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
},
"description": "Device (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "device_status__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device type (model)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device type (model)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "installed_device",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
},
"description": "Installed device (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "installed_device__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
},
"description": "Installed device (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "installed_device_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Installed device (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "installed_device_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Installed device (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "label__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "location",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Location (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Location (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Location (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Location (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "rack",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Rack (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Rack (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Rack (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Rack (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site name (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site name (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "virtual_chassis",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Virtual Chassis",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Virtual Chassis",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual Chassis (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual Chassis (ID)",
"explode": true,
"style": "form"
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedDeviceBayList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_device_bays_create",
"description": "Post a list of device bay objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceBayRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/DeviceBayRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceBay"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_device_bays_bulk_update",
"description": "Put a list of device bay objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceBayRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceBayRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceBay"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_device_bays_bulk_partial_update",
"description": "Patch a list of device bay objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceBayRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceBayRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceBay"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_device_bays_bulk_destroy",
"description": "Delete a list of device bay objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceBayRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceBayRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/device-bays/{id}/": {
"get": {
"operationId": "dcim_device_bays_retrieve",
"description": "Get a device bay object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this device bay.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceBay"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_device_bays_update",
"description": "Put a device bay object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this device bay.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceBayRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/DeviceBayRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceBay"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_device_bays_partial_update",
"description": "Patch a device bay object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this device bay.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedDeviceBayRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedDeviceBayRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceBay"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_device_bays_destroy",
"description": "Delete a device bay object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this device bay.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/device-roles/": {
"get": {
"operationId": "dcim_device_roles_list",
"description": "Get a list of device role objects.",
"parameters": [
{
"in": "query",
"name": "ancestor",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ancestor__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ancestor_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ancestor_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "color__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "config_template_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Config template (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "config_template_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Config template (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "parent",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Parent device role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "parent__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Parent device role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "parent_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Parent device role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "parent_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Parent device role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "slug",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "slug__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "vm_role",
"schema": {
"type": "boolean"
}
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedDeviceRoleList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_device_roles_create",
"description": "Post a list of device role objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableDeviceRoleRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableDeviceRoleRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceRole"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_device_roles_bulk_update",
"description": "Put a list of device role objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceRoleRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceRoleRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceRole"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_device_roles_bulk_partial_update",
"description": "Patch a list of device role objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceRoleRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceRoleRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceRole"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_device_roles_bulk_destroy",
"description": "Delete a list of device role objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceRoleRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceRoleRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/device-roles/{id}/": {
"get": {
"operationId": "dcim_device_roles_retrieve",
"description": "Get a device role object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this device role.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceRole"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_device_roles_update",
"description": "Put a device role object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this device role.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableDeviceRoleRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableDeviceRoleRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceRole"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_device_roles_partial_update",
"description": "Patch a device role object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this device role.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableDeviceRoleRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableDeviceRoleRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceRole"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_device_roles_destroy",
"description": "Delete a device role object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this device role.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/device-types/": {
"get": {
"operationId": "dcim_device_types_list",
"description": "Get a list of device type objects.",
"parameters": [
{
"in": "query",
"name": "airflow",
"schema": {
"type": "string",
"x-spec-enum-id": "943288113dad6782",
"nullable": true,
"enum": [
"bottom-to-top",
"front-to-rear",
"left-to-right",
"mixed",
"passive",
"rear-to-front",
"rear-to-side",
"right-to-left",
"side-to-rear",
"top-to-bottom"
]
},
"description": "* `front-to-rear` - Front to rear\n* `rear-to-front` - Rear to front\n* `left-to-right` - Left to right\n* `right-to-left` - Right to left\n* `side-to-rear` - Side to rear\n* `rear-to-side` - Rear to side\n* `bottom-to-top` - Bottom to top\n* `top-to-bottom` - Top to bottom\n* `passive` - Passive\n* `mixed` - Mixed"
},
{
"in": "query",
"name": "console_port_template_count",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "console_port_template_count__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "console_port_template_count__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "console_port_template_count__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "console_port_template_count__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "console_port_template_count__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "console_port_template_count__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "console_ports",
"schema": {
"type": "boolean"
},
"description": "Has console ports"
},
{
"in": "query",
"name": "console_server_port_template_count",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "console_server_port_template_count__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "console_server_port_template_count__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "console_server_port_template_count__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "console_server_port_template_count__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "console_server_port_template_count__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "console_server_port_template_count__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "console_server_ports",
"schema": {
"type": "boolean"
},
"description": "Has console server ports"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "default_platform",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "default_platform__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "default_platform_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "default_platform_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_bay_template_count",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_bay_template_count__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "device_bay_template_count__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_bay_template_count__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_bay_template_count__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_bay_template_count__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_bay_template_count__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_bays",
"schema": {
"type": "boolean"
},
"description": "Has device bays"
},
{
"in": "query",
"name": "exclude_from_utilization",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "front_port_template_count",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "front_port_template_count__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "front_port_template_count__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "front_port_template_count__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "front_port_template_count__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "front_port_template_count__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "front_port_template_count__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "has_front_image",
"schema": {
"type": "boolean"
},
"description": "Has a front image"
},
{
"in": "query",
"name": "has_rear_image",
"schema": {
"type": "boolean"
},
"description": "Has a rear image"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface_template_count",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface_template_count__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "interface_template_count__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface_template_count__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface_template_count__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface_template_count__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface_template_count__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interfaces",
"schema": {
"type": "boolean"
},
"description": "Has interfaces"
},
{
"in": "query",
"name": "inventory_item_template_count",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "inventory_item_template_count__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "inventory_item_template_count__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "inventory_item_template_count__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "inventory_item_template_count__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "inventory_item_template_count__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "inventory_item_template_count__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "inventory_items",
"schema": {
"type": "boolean"
},
"description": "Has inventory items"
},
{
"in": "query",
"name": "is_full_depth",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "manufacturer",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Manufacturer (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "manufacturer__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Manufacturer (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "manufacturer_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Manufacturer (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "manufacturer_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Manufacturer (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "model__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "module_bay_template_count",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "module_bay_template_count__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "module_bay_template_count__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "module_bay_template_count__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "module_bay_template_count__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "module_bay_template_count__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "module_bay_template_count__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "module_bays",
"schema": {
"type": "boolean"
},
"description": "Has module bays"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "part_number",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_number__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "part_number__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_number__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_number__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_number__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_number__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_number__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_number__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_number__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_number__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_number__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_number__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "pass_through_ports",
"schema": {
"type": "boolean"
},
"description": "Has pass-through ports"
},
{
"in": "query",
"name": "power_outlet_template_count",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "power_outlet_template_count__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "power_outlet_template_count__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "power_outlet_template_count__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "power_outlet_template_count__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "power_outlet_template_count__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "power_outlet_template_count__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "power_outlets",
"schema": {
"type": "boolean"
},
"description": "Has power outlets"
},
{
"in": "query",
"name": "power_port_template_count",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "power_port_template_count__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "power_port_template_count__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "power_port_template_count__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "power_port_template_count__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "power_port_template_count__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "power_port_template_count__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "power_ports",
"schema": {
"type": "boolean"
},
"description": "Has power ports"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "rear_port_template_count",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rear_port_template_count__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "rear_port_template_count__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rear_port_template_count__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rear_port_template_count__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rear_port_template_count__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rear_port_template_count__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "slug__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "subdevice_role",
"schema": {
"type": "string",
"x-spec-enum-id": "d10d91f690a856c2",
"nullable": true,
"title": "Parent/child status",
"enum": [
"child",
"parent"
]
},
"description": "Parent devices house child devices in device bays. Leave blank if this device type is neither a parent nor a child.\n\n* `parent` - Parent\n* `child` - Child"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "u_height",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "u_height__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "u_height__gt",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "u_height__gte",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "u_height__lt",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "u_height__lte",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "u_height__n",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "weight",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "weight__gt",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__gte",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__lt",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__lte",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__n",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight_unit",
"schema": {
"type": "string",
"x-spec-enum-id": "7c1876f422815884",
"nullable": true,
"enum": [
"g",
"kg",
"lb",
"oz"
]
},
"description": "* `kg` - Kilograms\n* `g` - Grams\n* `lb` - Pounds\n* `oz` - Ounces"
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedDeviceTypeList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_device_types_create",
"description": "Post a list of device type objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableDeviceTypeRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableDeviceTypeRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceType"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_device_types_bulk_update",
"description": "Put a list of device type objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceTypeRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceTypeRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceType"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_device_types_bulk_partial_update",
"description": "Patch a list of device type objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceTypeRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceTypeRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceType"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_device_types_bulk_destroy",
"description": "Delete a list of device type objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceTypeRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceTypeRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/device-types/{id}/": {
"get": {
"operationId": "dcim_device_types_retrieve",
"description": "Get a device type object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this device type.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceType"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_device_types_update",
"description": "Put a device type object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this device type.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableDeviceTypeRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableDeviceTypeRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceType"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_device_types_partial_update",
"description": "Patch a device type object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this device type.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableDeviceTypeRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableDeviceTypeRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceType"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_device_types_destroy",
"description": "Delete a device type object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this device type.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/devices/": {
"get": {
"operationId": "dcim_devices_list",
"description": "Get a list of device objects.",
"parameters": [
{
"in": "query",
"name": "airflow",
"schema": {
"type": "string",
"x-spec-enum-id": "943288113dad6782",
"nullable": true,
"enum": [
"bottom-to-top",
"front-to-rear",
"left-to-right",
"mixed",
"passive",
"rear-to-front",
"rear-to-side",
"right-to-left",
"side-to-rear",
"top-to-bottom"
]
},
"description": "* `front-to-rear` - Front to rear\n* `rear-to-front` - Rear to front\n* `left-to-right` - Left to right\n* `right-to-left` - Right to left\n* `side-to-rear` - Side to rear\n* `rear-to-side` - Rear to side\n* `bottom-to-top` - Bottom to top\n* `top-to-bottom` - Top to bottom\n* `passive` - Passive\n* `mixed` - Mixed"
},
{
"in": "query",
"name": "asset_tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "asset_tag__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cluster_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Cluster group (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cluster_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Cluster group (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cluster_group_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Cluster group (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cluster_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Cluster group (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cluster_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "VM cluster (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cluster_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "VM cluster (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "config_template_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Config template (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "config_template_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Config template (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "console_port_count",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "console_port_count__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "console_port_count__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "console_port_count__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "console_port_count__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "console_port_count__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "console_port_count__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "console_ports",
"schema": {
"type": "boolean"
},
"description": "Has console ports"
},
{
"in": "query",
"name": "console_server_port_count",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "console_server_port_count__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "console_server_port_count__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "console_server_port_count__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "console_server_port_count__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "console_server_port_count__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "console_server_port_count__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "console_server_ports",
"schema": {
"type": "boolean"
},
"description": "Has console server ports"
},
{
"in": "query",
"name": "contact",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_bay_count",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_bay_count__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "device_bay_count__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_bay_count__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_bay_count__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_bay_count__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_bay_count__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_bays",
"schema": {
"type": "boolean"
},
"description": "Has device bays"
},
{
"in": "query",
"name": "device_type",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device type (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device type (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "face",
"schema": {
"type": "string",
"x-spec-enum-id": "d2fb9b3f75158b83",
"nullable": true,
"title": "Rack face",
"enum": [
"front",
"rear"
]
},
"description": "* `front` - Front\n* `rear` - Rear"
},
{
"in": "query",
"name": "front_port_count",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "front_port_count__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "front_port_count__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "front_port_count__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "front_port_count__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "front_port_count__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "front_port_count__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "has_oob_ip",
"schema": {
"type": "boolean"
},
"description": "Has an out-of-band IP"
},
{
"in": "query",
"name": "has_primary_ip",
"schema": {
"type": "boolean"
},
"description": "Has a primary IP"
},
{
"in": "query",
"name": "has_virtual_device_context",
"schema": {
"type": "boolean"
},
"description": "Has virtual device context"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface_count",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface_count__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "interface_count__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface_count__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface_count__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface_count__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface_count__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interfaces",
"schema": {
"type": "boolean"
},
"description": "Has interfaces"
},
{
"in": "query",
"name": "inventory_item_count",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "inventory_item_count__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "inventory_item_count__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "inventory_item_count__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "inventory_item_count__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "inventory_item_count__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "inventory_item_count__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "is_full_depth",
"schema": {
"type": "boolean"
},
"description": "Is full depth"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "latitude",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "latitude__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "latitude__gt",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "latitude__gte",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "latitude__lt",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "latitude__lte",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "latitude__n",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "local_context_data",
"schema": {
"type": "boolean"
},
"description": "Has local config context data"
},
{
"in": "query",
"name": "location",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "longitude",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "longitude__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "longitude__gt",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "longitude__gte",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "longitude__lt",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "longitude__lte",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "longitude__n",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "manufacturer",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Manufacturer (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "manufacturer__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Manufacturer (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "manufacturer_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Manufacturer (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "manufacturer_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Manufacturer (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device model (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device model (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "module_bay_count",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "module_bay_count__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "module_bay_count__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "module_bay_count__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "module_bay_count__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "module_bay_count__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "module_bay_count__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "module_bays",
"schema": {
"type": "boolean"
},
"description": "Has module bays"
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "oob_ip_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "OOB IP (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "oob_ip_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "OOB IP (ID)",
"explode": true,
"style": "form"
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "parent_bay_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Parent bay (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "parent_bay_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Parent bay (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "parent_device_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Parent Device (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "parent_device_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Parent Device (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "pass_through_ports",
"schema": {
"type": "boolean"
},
"description": "Has pass-through ports"
},
{
"in": "query",
"name": "platform",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "platform__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "platform_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "platform_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "position",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "position__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "position__gt",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "position__gte",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "position__lt",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "position__lte",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "position__n",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "power_outlet_count",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "power_outlet_count__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "power_outlet_count__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "power_outlet_count__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "power_outlet_count__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "power_outlet_count__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "power_outlet_count__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "power_outlets",
"schema": {
"type": "boolean"
},
"description": "Has power outlets"
},
{
"in": "query",
"name": "power_port_count",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "power_port_count__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "power_port_count__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "power_port_count__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "power_port_count__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "power_port_count__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "power_port_count__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "power_ports",
"schema": {
"type": "boolean"
},
"description": "Has power ports"
},
{
"in": "query",
"name": "primary_ip4",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Primary IPv4 (address)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "primary_ip4__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Primary IPv4 (address)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "primary_ip4_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Primary IPv4 (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "primary_ip4_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Primary IPv4 (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "primary_ip6",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Primary IPv6 (address)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "primary_ip6__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Primary IPv6 (address)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "primary_ip6_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Primary IPv6 (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "primary_ip6_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Primary IPv6 (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "rack_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Rack (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Rack (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rear_port_count",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rear_port_count__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "rear_port_count__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rear_port_count__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rear_port_count__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rear_port_count__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rear_port_count__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "serial__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site name (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site name (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "status__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "vc_position",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vc_position__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "vc_position__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vc_position__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vc_position__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vc_position__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vc_position__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vc_priority",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vc_priority__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "vc_priority__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vc_priority__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vc_priority__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vc_priority__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vc_priority__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual chassis (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual chassis (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis_member",
"schema": {
"type": "boolean"
},
"description": "Is a virtual chassis member"
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedDeviceWithConfigContextList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_devices_create",
"description": "Post a list of device objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableDeviceWithConfigContextRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableDeviceWithConfigContextRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceWithConfigContext"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_devices_bulk_update",
"description": "Put a list of device objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceWithConfigContextRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceWithConfigContextRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceWithConfigContext"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_devices_bulk_partial_update",
"description": "Patch a list of device objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceWithConfigContextRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceWithConfigContextRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceWithConfigContext"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_devices_bulk_destroy",
"description": "Delete a list of device objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceWithConfigContextRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceWithConfigContextRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/devices/{id}/": {
"get": {
"operationId": "dcim_devices_retrieve",
"description": "Get a device object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this device.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceWithConfigContext"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_devices_update",
"description": "Put a device object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this device.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableDeviceWithConfigContextRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableDeviceWithConfigContextRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceWithConfigContext"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_devices_partial_update",
"description": "Patch a device object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this device.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableDeviceWithConfigContextRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableDeviceWithConfigContextRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceWithConfigContext"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_devices_destroy",
"description": "Delete a device object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this device.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/devices/{id}/render-config/": {
"post": {
"operationId": "dcim_devices_render_config_create",
"description": "Resolve and render the preferred ConfigTemplate for this Device.",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"json",
"txt"
]
}
},
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this device.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableDeviceWithConfigContextRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableDeviceWithConfigContextRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceWithConfigContext"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/DeviceWithConfigContext"
}
}
},
"description": ""
}
}
}
},
"/api/dcim/front-port-templates/": {
"get": {
"operationId": "dcim_front_port_templates_list",
"description": "Get a list of front port template objects.",
"parameters": [
{
"in": "query",
"name": "color",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "color__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "label__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "module_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Module type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "module_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Module type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "rear_port_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rear_port_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rear_port_position",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rear_port_position__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "rear_port_position__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rear_port_position__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rear_port_position__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rear_port_position__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rear_port_position__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ea67ae8ba4602f8a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "type__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ea67ae8ba4602f8a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ea67ae8ba4602f8a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ea67ae8ba4602f8a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ea67ae8ba4602f8a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ea67ae8ba4602f8a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ea67ae8ba4602f8a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ea67ae8ba4602f8a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ea67ae8ba4602f8a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ea67ae8ba4602f8a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ea67ae8ba4602f8a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ea67ae8ba4602f8a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedFrontPortTemplateList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_front_port_templates_create",
"description": "Post a list of front port template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableFrontPortTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableFrontPortTemplateRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FrontPortTemplate"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_front_port_templates_bulk_update",
"description": "Put a list of front port template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FrontPortTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FrontPortTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FrontPortTemplate"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_front_port_templates_bulk_partial_update",
"description": "Patch a list of front port template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FrontPortTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FrontPortTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FrontPortTemplate"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_front_port_templates_bulk_destroy",
"description": "Delete a list of front port template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FrontPortTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FrontPortTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/front-port-templates/{id}/": {
"get": {
"operationId": "dcim_front_port_templates_retrieve",
"description": "Get a front port template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this front port template.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FrontPortTemplate"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_front_port_templates_update",
"description": "Put a front port template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this front port template.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableFrontPortTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableFrontPortTemplateRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FrontPortTemplate"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_front_port_templates_partial_update",
"description": "Patch a front port template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this front port template.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableFrontPortTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableFrontPortTemplateRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FrontPortTemplate"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_front_port_templates_destroy",
"description": "Delete a front port template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this front port template.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/front-ports/": {
"get": {
"operationId": "dcim_front_ports_list",
"description": "Get a list of front port objects.",
"parameters": [
{
"in": "query",
"name": "cable_end",
"schema": {
"type": "string",
"x-spec-enum-id": "1db84f9b93b261c8",
"nullable": true,
"enum": [
"A",
"B"
]
},
"description": "* `A` - A\n* `B` - B"
},
{
"in": "query",
"name": "cable_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Cable (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cable_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Cable (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cabled",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "color",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "color__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
},
"description": "Device (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
},
"description": "Device (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "device_status__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device type (model)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device type (model)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "label__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "location",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Location (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Location (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Location (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Location (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mark_connected",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "module_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Module (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "module_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Module (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "occupied",
"schema": {
"type": "boolean"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "rack",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Rack (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Rack (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Rack (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Rack (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rear_port_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rear_port_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rear_port_position",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rear_port_position__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "rear_port_position__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rear_port_position__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rear_port_position__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rear_port_position__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rear_port_position__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site name (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site name (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ea67ae8ba4602f8a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "type__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ea67ae8ba4602f8a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ea67ae8ba4602f8a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ea67ae8ba4602f8a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ea67ae8ba4602f8a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ea67ae8ba4602f8a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ea67ae8ba4602f8a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ea67ae8ba4602f8a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ea67ae8ba4602f8a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ea67ae8ba4602f8a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ea67ae8ba4602f8a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ea67ae8ba4602f8a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "virtual_chassis",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Virtual Chassis",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Virtual Chassis",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual Chassis (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual Chassis (ID)",
"explode": true,
"style": "form"
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedFrontPortList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_front_ports_create",
"description": "Post a list of front port objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableFrontPortRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableFrontPortRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FrontPort"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_front_ports_bulk_update",
"description": "Put a list of front port objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FrontPortRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FrontPortRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FrontPort"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_front_ports_bulk_partial_update",
"description": "Patch a list of front port objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FrontPortRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FrontPortRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FrontPort"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_front_ports_bulk_destroy",
"description": "Delete a list of front port objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FrontPortRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FrontPortRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/front-ports/{id}/": {
"get": {
"operationId": "dcim_front_ports_retrieve",
"description": "Get a front port object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this front port.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FrontPort"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_front_ports_update",
"description": "Put a front port object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this front port.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableFrontPortRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableFrontPortRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FrontPort"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_front_ports_partial_update",
"description": "Patch a front port object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this front port.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableFrontPortRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableFrontPortRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FrontPort"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_front_ports_destroy",
"description": "Delete a front port object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this front port.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/front-ports/{id}/paths/": {
"get": {
"operationId": "dcim_front_ports_paths_retrieve",
"description": "Return all CablePaths which traverse a given pass-through port.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this front port.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FrontPort"
}
}
},
"description": ""
}
}
}
},
"/api/dcim/interface-templates/": {
"get": {
"operationId": "dcim_interface_templates_list",
"description": "Get a list of interface template objects.",
"parameters": [
{
"in": "query",
"name": "bridge_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "bridge_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "enabled",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "label__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "mgmt_only",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "module_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Module type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "module_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Module type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "poe_mode",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2f2fe6dcdc7772bd",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_mode__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "poe_mode__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2f2fe6dcdc7772bd",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_mode__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2f2fe6dcdc7772bd",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_mode__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2f2fe6dcdc7772bd",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_mode__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2f2fe6dcdc7772bd",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_mode__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2f2fe6dcdc7772bd",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_mode__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2f2fe6dcdc7772bd",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_mode__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2f2fe6dcdc7772bd",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_mode__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2f2fe6dcdc7772bd",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_mode__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2f2fe6dcdc7772bd",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_mode__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2f2fe6dcdc7772bd",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_mode__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2f2fe6dcdc7772bd",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_type",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "74bd3be4012f6da9",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_type__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "poe_type__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "74bd3be4012f6da9",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_type__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "74bd3be4012f6da9",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_type__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "74bd3be4012f6da9",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_type__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "74bd3be4012f6da9",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_type__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "74bd3be4012f6da9",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_type__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "74bd3be4012f6da9",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_type__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "74bd3be4012f6da9",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_type__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "74bd3be4012f6da9",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_type__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "74bd3be4012f6da9",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_type__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "74bd3be4012f6da9",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_type__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "74bd3be4012f6da9",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "rf_role",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d2772dbea88b0fb1",
"nullable": true,
"title": "Wireless role"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_role__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "rf_role__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d2772dbea88b0fb1",
"nullable": true,
"title": "Wireless role"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_role__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d2772dbea88b0fb1",
"nullable": true,
"title": "Wireless role"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_role__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d2772dbea88b0fb1",
"nullable": true,
"title": "Wireless role"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_role__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d2772dbea88b0fb1",
"nullable": true,
"title": "Wireless role"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_role__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d2772dbea88b0fb1",
"nullable": true,
"title": "Wireless role"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_role__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d2772dbea88b0fb1",
"nullable": true,
"title": "Wireless role"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_role__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d2772dbea88b0fb1",
"nullable": true,
"title": "Wireless role"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_role__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d2772dbea88b0fb1",
"nullable": true,
"title": "Wireless role"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_role__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d2772dbea88b0fb1",
"nullable": true,
"title": "Wireless role"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_role__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d2772dbea88b0fb1",
"nullable": true,
"title": "Wireless role"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_role__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d2772dbea88b0fb1",
"nullable": true,
"title": "Wireless role"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8c4c5e112f77a383"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "type__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8c4c5e112f77a383"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8c4c5e112f77a383"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8c4c5e112f77a383"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8c4c5e112f77a383"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8c4c5e112f77a383"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8c4c5e112f77a383"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8c4c5e112f77a383"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8c4c5e112f77a383"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8c4c5e112f77a383"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8c4c5e112f77a383"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8c4c5e112f77a383"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedInterfaceTemplateList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_interface_templates_create",
"description": "Post a list of interface template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableInterfaceTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableInterfaceTemplateRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InterfaceTemplate"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_interface_templates_bulk_update",
"description": "Put a list of interface template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InterfaceTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InterfaceTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InterfaceTemplate"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_interface_templates_bulk_partial_update",
"description": "Patch a list of interface template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InterfaceTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InterfaceTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InterfaceTemplate"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_interface_templates_bulk_destroy",
"description": "Delete a list of interface template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InterfaceTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InterfaceTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/interface-templates/{id}/": {
"get": {
"operationId": "dcim_interface_templates_retrieve",
"description": "Get a interface template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this interface template.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InterfaceTemplate"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_interface_templates_update",
"description": "Put a interface template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this interface template.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableInterfaceTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableInterfaceTemplateRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InterfaceTemplate"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_interface_templates_partial_update",
"description": "Patch a interface template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this interface template.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableInterfaceTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableInterfaceTemplateRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InterfaceTemplate"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_interface_templates_destroy",
"description": "Delete a interface template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this interface template.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/interfaces/": {
"get": {
"operationId": "dcim_interfaces_list",
"description": "Get a list of interface objects.",
"parameters": [
{
"in": "query",
"name": "bridge_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Bridged interface (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "bridge_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Bridged interface (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cable_end",
"schema": {
"type": "string",
"x-spec-enum-id": "1db84f9b93b261c8",
"nullable": true,
"enum": [
"A",
"B"
]
},
"description": "* `A` - A\n* `B` - B"
},
{
"in": "query",
"name": "cable_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Cable (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cable_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Cable (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cabled",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "connected",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
},
"description": "Device (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
},
"description": "Device (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "device_status__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device type (model)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device type (model)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "duplex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "47eab9b1a65a1e21",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "duplex__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "duplex__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "47eab9b1a65a1e21",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "duplex__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "47eab9b1a65a1e21",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "duplex__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "47eab9b1a65a1e21",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "duplex__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "47eab9b1a65a1e21",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "duplex__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "47eab9b1a65a1e21",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "duplex__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "47eab9b1a65a1e21",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "duplex__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "47eab9b1a65a1e21",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "duplex__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "47eab9b1a65a1e21",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "duplex__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "47eab9b1a65a1e21",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "duplex__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "47eab9b1a65a1e21",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "duplex__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "47eab9b1a65a1e21",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "enabled",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "kind",
"schema": {
"type": "string"
},
"description": "Kind of interface"
},
{
"in": "query",
"name": "l2vpn",
"schema": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"format": "int64",
"nullable": true
}
},
"description": "L2VPN",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "l2vpn__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"format": "int64",
"nullable": true
}
},
"description": "L2VPN",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "l2vpn_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "L2VPN (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "l2vpn_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "L2VPN (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "label__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "lag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "LAG interface (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "lag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "LAG interface (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "location",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Location (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Location (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Location (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Location (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mark_connected",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "mgmt_only",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "mode",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b6fe48fe21dbf01d",
"nullable": true
}
},
"description": "802.1Q Mode",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mode__empty",
"schema": {
"type": "boolean"
},
"description": "802.1Q Mode"
},
{
"in": "query",
"name": "mode__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b6fe48fe21dbf01d",
"nullable": true
}
},
"description": "802.1Q Mode",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mode__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b6fe48fe21dbf01d",
"nullable": true
}
},
"description": "802.1Q Mode",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mode__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b6fe48fe21dbf01d",
"nullable": true
}
},
"description": "802.1Q Mode",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mode__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b6fe48fe21dbf01d",
"nullable": true
}
},
"description": "802.1Q Mode",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mode__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b6fe48fe21dbf01d",
"nullable": true
}
},
"description": "802.1Q Mode",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mode__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b6fe48fe21dbf01d",
"nullable": true
}
},
"description": "802.1Q Mode",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mode__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b6fe48fe21dbf01d",
"nullable": true
}
},
"description": "802.1Q Mode",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mode__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b6fe48fe21dbf01d",
"nullable": true
}
},
"description": "802.1Q Mode",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mode__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b6fe48fe21dbf01d",
"nullable": true
}
},
"description": "802.1Q Mode",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mode__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b6fe48fe21dbf01d",
"nullable": true
}
},
"description": "802.1Q Mode",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mode__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b6fe48fe21dbf01d",
"nullable": true
}
},
"description": "802.1Q Mode",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "module_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Module (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "module_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Module (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mtu",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mtu__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "mtu__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mtu__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mtu__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mtu__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mtu__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "occupied",
"schema": {
"type": "boolean"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "parent_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Parent interface (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "parent_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Parent interface (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_mode",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2f2fe6dcdc7772bd",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_mode__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "poe_mode__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2f2fe6dcdc7772bd",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_mode__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2f2fe6dcdc7772bd",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_mode__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2f2fe6dcdc7772bd",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_mode__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2f2fe6dcdc7772bd",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_mode__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2f2fe6dcdc7772bd",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_mode__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2f2fe6dcdc7772bd",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_mode__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2f2fe6dcdc7772bd",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_mode__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2f2fe6dcdc7772bd",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_mode__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2f2fe6dcdc7772bd",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_mode__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2f2fe6dcdc7772bd",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_mode__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2f2fe6dcdc7772bd",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_type",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "74bd3be4012f6da9",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_type__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "poe_type__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "74bd3be4012f6da9",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_type__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "74bd3be4012f6da9",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_type__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "74bd3be4012f6da9",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_type__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "74bd3be4012f6da9",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_type__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "74bd3be4012f6da9",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_type__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "74bd3be4012f6da9",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_type__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "74bd3be4012f6da9",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_type__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "74bd3be4012f6da9",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_type__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "74bd3be4012f6da9",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_type__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "74bd3be4012f6da9",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "poe_type__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "74bd3be4012f6da9",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "primary_mac_address",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Primary MAC address",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "primary_mac_address__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Primary MAC address",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "primary_mac_address_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Primary MAC address (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "primary_mac_address_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Primary MAC address (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "rack",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Rack (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Rack (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Rack (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Rack (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_channel",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "aac33cc237adc8f9",
"nullable": true,
"title": "Wireless channel"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_channel__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "rf_channel__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "aac33cc237adc8f9",
"nullable": true,
"title": "Wireless channel"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_channel__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "aac33cc237adc8f9",
"nullable": true,
"title": "Wireless channel"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_channel__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "aac33cc237adc8f9",
"nullable": true,
"title": "Wireless channel"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_channel__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "aac33cc237adc8f9",
"nullable": true,
"title": "Wireless channel"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_channel__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "aac33cc237adc8f9",
"nullable": true,
"title": "Wireless channel"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_channel__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "aac33cc237adc8f9",
"nullable": true,
"title": "Wireless channel"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_channel__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "aac33cc237adc8f9",
"nullable": true,
"title": "Wireless channel"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_channel__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "aac33cc237adc8f9",
"nullable": true,
"title": "Wireless channel"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_channel__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "aac33cc237adc8f9",
"nullable": true,
"title": "Wireless channel"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_channel__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "aac33cc237adc8f9",
"nullable": true,
"title": "Wireless channel"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_channel__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "aac33cc237adc8f9",
"nullable": true,
"title": "Wireless channel"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_channel_frequency",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_channel_frequency__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "rf_channel_frequency__gt",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_channel_frequency__gte",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_channel_frequency__lt",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_channel_frequency__lte",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_channel_frequency__n",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_channel_width",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_channel_width__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "rf_channel_width__gt",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_channel_width__gte",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_channel_width__lt",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_channel_width__lte",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_channel_width__n",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_role",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d2772dbea88b0fb1",
"nullable": true,
"title": "Wireless role"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_role__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "rf_role__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d2772dbea88b0fb1",
"nullable": true,
"title": "Wireless role"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_role__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d2772dbea88b0fb1",
"nullable": true,
"title": "Wireless role"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_role__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d2772dbea88b0fb1",
"nullable": true,
"title": "Wireless role"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_role__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d2772dbea88b0fb1",
"nullable": true,
"title": "Wireless role"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_role__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d2772dbea88b0fb1",
"nullable": true,
"title": "Wireless role"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_role__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d2772dbea88b0fb1",
"nullable": true,
"title": "Wireless role"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_role__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d2772dbea88b0fb1",
"nullable": true,
"title": "Wireless role"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_role__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d2772dbea88b0fb1",
"nullable": true,
"title": "Wireless role"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_role__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d2772dbea88b0fb1",
"nullable": true,
"title": "Wireless role"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_role__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d2772dbea88b0fb1",
"nullable": true,
"title": "Wireless role"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rf_role__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d2772dbea88b0fb1",
"nullable": true,
"title": "Wireless role"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site name (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site name (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "speed",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "speed__empty",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "speed__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "speed__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "speed__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "speed__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "speed__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tx_power",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tx_power__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "tx_power__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tx_power__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tx_power__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tx_power__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tx_power__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8c4c5e112f77a383"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "type__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8c4c5e112f77a383"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8c4c5e112f77a383"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8c4c5e112f77a383"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8c4c5e112f77a383"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8c4c5e112f77a383"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8c4c5e112f77a383"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8c4c5e112f77a383"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8c4c5e112f77a383"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8c4c5e112f77a383"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8c4c5e112f77a383"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8c4c5e112f77a383"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "vdc",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Virtual Device Context",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vdc__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Virtual Device Context",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vdc_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual Device Context",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vdc_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual Device Context",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vdc_identifier",
"schema": {
"type": "array",
"items": {
"type": "integer",
"maximum": 32767,
"minimum": 0,
"nullable": true
}
},
"description": "Virtual Device Context (Identifier)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vdc_identifier__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"maximum": 32767,
"minimum": 0,
"nullable": true
}
},
"description": "Virtual Device Context (Identifier)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Virtual Chassis",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Virtual Chassis",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual Chassis (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual Chassis (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis_member",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis_member_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis_member_or_master",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis_member_or_master_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_circuit_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual circuit (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_circuit_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual circuit (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_circuit_termination_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual circuit termination (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_circuit_termination_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual circuit termination (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vlan",
"schema": {
"type": "string"
},
"description": "Assigned VID"
},
{
"in": "query",
"name": "vlan_id",
"schema": {
"type": "string"
},
"description": "Assigned VLAN"
},
{
"in": "query",
"name": "vlan_translation_policy",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "VLAN Translation Policy",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vlan_translation_policy__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "VLAN Translation Policy",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vlan_translation_policy_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "VLAN Translation Policy (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vlan_translation_policy_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "VLAN Translation Policy (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vrf",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true,
"title": "Route distinguisher"
}
},
"description": "VRF (RD)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vrf__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true,
"title": "Route distinguisher"
}
},
"description": "VRF (RD)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vrf_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "VRF",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vrf_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "VRF",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "wireless_lan_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Wireless LAN",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "wireless_lan_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Wireless LAN",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "wireless_link_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Wireless link",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "wireless_link_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Wireless link",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "wwn",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "wwn__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "wwn__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "wwn__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "wwn__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "wwn__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "wwn__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "wwn__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "wwn__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "wwn__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "wwn__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "wwn__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedInterfaceList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_interfaces_create",
"description": "Post a list of interface objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableInterfaceRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableInterfaceRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Interface"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_interfaces_bulk_update",
"description": "Put a list of interface objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InterfaceRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InterfaceRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Interface"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_interfaces_bulk_partial_update",
"description": "Patch a list of interface objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InterfaceRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InterfaceRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Interface"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_interfaces_bulk_destroy",
"description": "Delete a list of interface objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InterfaceRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InterfaceRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/interfaces/{id}/": {
"get": {
"operationId": "dcim_interfaces_retrieve",
"description": "Get a interface object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this interface.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Interface"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_interfaces_update",
"description": "Put a interface object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this interface.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableInterfaceRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableInterfaceRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Interface"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_interfaces_partial_update",
"description": "Patch a interface object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this interface.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableInterfaceRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableInterfaceRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Interface"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_interfaces_destroy",
"description": "Delete a interface object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this interface.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/interfaces/{id}/trace/": {
"get": {
"operationId": "dcim_interfaces_trace_retrieve",
"description": "Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this interface.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Interface"
}
}
},
"description": ""
}
}
}
},
"/api/dcim/inventory-item-roles/": {
"get": {
"operationId": "dcim_inventory_item_roles_list",
"description": "Get a list of inventory item role objects.",
"parameters": [
{
"in": "query",
"name": "color",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "color__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "slug",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "slug__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedInventoryItemRoleList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_inventory_item_roles_create",
"description": "Post a list of inventory item role objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InventoryItemRoleRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/InventoryItemRoleRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InventoryItemRole"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_inventory_item_roles_bulk_update",
"description": "Put a list of inventory item role objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InventoryItemRoleRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InventoryItemRoleRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InventoryItemRole"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_inventory_item_roles_bulk_partial_update",
"description": "Patch a list of inventory item role objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InventoryItemRoleRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InventoryItemRoleRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InventoryItemRole"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_inventory_item_roles_bulk_destroy",
"description": "Delete a list of inventory item role objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InventoryItemRoleRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InventoryItemRoleRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/inventory-item-roles/{id}/": {
"get": {
"operationId": "dcim_inventory_item_roles_retrieve",
"description": "Get a inventory item role object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this inventory item role.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InventoryItemRole"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_inventory_item_roles_update",
"description": "Put a inventory item role object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this inventory item role.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InventoryItemRoleRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/InventoryItemRoleRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InventoryItemRole"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_inventory_item_roles_partial_update",
"description": "Patch a inventory item role object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this inventory item role.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedInventoryItemRoleRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedInventoryItemRoleRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InventoryItemRole"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_inventory_item_roles_destroy",
"description": "Delete a inventory item role object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this inventory item role.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/inventory-item-templates/": {
"get": {
"operationId": "dcim_inventory_item_templates_list",
"description": "Get a list of inventory item template objects.",
"parameters": [
{
"in": "query",
"name": "component_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "component_id__empty",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "component_id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "component_id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "component_id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "component_id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "component_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "component_type",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "component_type__n",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "label__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "manufacturer",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Manufacturer (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "manufacturer__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Manufacturer (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "manufacturer_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Manufacturer (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "manufacturer_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Manufacturer (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "parent_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Parent inventory item (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "parent_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Parent inventory item (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "part_id__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_id__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_id__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_id__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_id__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_id__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_id__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_id__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_id__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_id__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "role",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedInventoryItemTemplateList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_inventory_item_templates_create",
"description": "Post a list of inventory item template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InventoryItemTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/InventoryItemTemplateRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InventoryItemTemplate"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_inventory_item_templates_bulk_update",
"description": "Put a list of inventory item template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InventoryItemTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InventoryItemTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InventoryItemTemplate"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_inventory_item_templates_bulk_partial_update",
"description": "Patch a list of inventory item template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InventoryItemTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InventoryItemTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InventoryItemTemplate"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_inventory_item_templates_bulk_destroy",
"description": "Delete a list of inventory item template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InventoryItemTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InventoryItemTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/inventory-item-templates/{id}/": {
"get": {
"operationId": "dcim_inventory_item_templates_retrieve",
"description": "Get a inventory item template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this inventory item template.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InventoryItemTemplate"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_inventory_item_templates_update",
"description": "Put a inventory item template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this inventory item template.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InventoryItemTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/InventoryItemTemplateRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InventoryItemTemplate"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_inventory_item_templates_partial_update",
"description": "Patch a inventory item template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this inventory item template.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedInventoryItemTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedInventoryItemTemplateRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InventoryItemTemplate"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_inventory_item_templates_destroy",
"description": "Delete a inventory item template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this inventory item template.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/inventory-items/": {
"get": {
"operationId": "dcim_inventory_items_list",
"description": "Get a list of inventory item objects.",
"parameters": [
{
"in": "query",
"name": "asset_tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "asset_tag__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "component_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "component_id__empty",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "component_id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "component_id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "component_id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "component_id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "component_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "component_type",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "component_type__n",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
},
"description": "Device (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
},
"description": "Device (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "device_status__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device type (model)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device type (model)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "discovered",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "label__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "location",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Location (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Location (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Location (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Location (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "manufacturer",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Manufacturer (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "manufacturer__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Manufacturer (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "manufacturer_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Manufacturer (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "manufacturer_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Manufacturer (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "parent_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Parent inventory item (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "parent_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Parent inventory item (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "part_id__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_id__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_id__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_id__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_id__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_id__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_id__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_id__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_id__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_id__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "rack",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Rack (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Rack (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Rack (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Rack (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "serial__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site name (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site name (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2217e87d0c3efdda"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "status__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2217e87d0c3efdda"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2217e87d0c3efdda"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2217e87d0c3efdda"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2217e87d0c3efdda"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2217e87d0c3efdda"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2217e87d0c3efdda"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2217e87d0c3efdda"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2217e87d0c3efdda"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2217e87d0c3efdda"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2217e87d0c3efdda"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2217e87d0c3efdda"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "virtual_chassis",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Virtual Chassis",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Virtual Chassis",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual Chassis (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual Chassis (ID)",
"explode": true,
"style": "form"
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedInventoryItemList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_inventory_items_create",
"description": "Post a list of inventory item objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableInventoryItemRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableInventoryItemRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InventoryItem"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_inventory_items_bulk_update",
"description": "Put a list of inventory item objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InventoryItemRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InventoryItemRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InventoryItem"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_inventory_items_bulk_partial_update",
"description": "Patch a list of inventory item objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InventoryItemRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InventoryItemRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InventoryItem"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_inventory_items_bulk_destroy",
"description": "Delete a list of inventory item objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InventoryItemRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InventoryItemRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/inventory-items/{id}/": {
"get": {
"operationId": "dcim_inventory_items_retrieve",
"description": "Get a inventory item object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this inventory item.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InventoryItem"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_inventory_items_update",
"description": "Put a inventory item object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this inventory item.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableInventoryItemRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableInventoryItemRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InventoryItem"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_inventory_items_partial_update",
"description": "Patch a inventory item object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this inventory item.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableInventoryItemRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableInventoryItemRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InventoryItem"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_inventory_items_destroy",
"description": "Delete a inventory item object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this inventory item.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/locations/": {
"get": {
"operationId": "dcim_locations_list",
"description": "Get a list of location objects.",
"parameters": [
{
"in": "query",
"name": "ancestor",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ancestor__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ancestor_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ancestor_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "facility",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "facility__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "facility__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "facility__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "facility__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "facility__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "facility__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "facility__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "facility__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "facility__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "facility__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "facility__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "facility__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "parent",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Parent location (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "parent__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Parent location (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "parent_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Parent location (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "parent_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Parent location (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "region",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "slug__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e363a8ddb138be50"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "status__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e363a8ddb138be50"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e363a8ddb138be50"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e363a8ddb138be50"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e363a8ddb138be50"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e363a8ddb138be50"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e363a8ddb138be50"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e363a8ddb138be50"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e363a8ddb138be50"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e363a8ddb138be50"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e363a8ddb138be50"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e363a8ddb138be50"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedLocationList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_locations_create",
"description": "Post a list of location objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableLocationRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableLocationRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Location"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_locations_bulk_update",
"description": "Put a list of location objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LocationRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LocationRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Location"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_locations_bulk_partial_update",
"description": "Patch a list of location objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LocationRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LocationRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Location"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_locations_bulk_destroy",
"description": "Delete a list of location objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LocationRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LocationRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/locations/{id}/": {
"get": {
"operationId": "dcim_locations_retrieve",
"description": "Get a location object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this location.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Location"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_locations_update",
"description": "Put a location object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this location.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableLocationRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableLocationRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Location"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_locations_partial_update",
"description": "Patch a location object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this location.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableLocationRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableLocationRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Location"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_locations_destroy",
"description": "Delete a location object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this location.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/mac-addresses/": {
"get": {
"operationId": "dcim_mac_addresses_list",
"description": "Get a list of MAC address objects.",
"parameters": [
{
"in": "query",
"name": "assigned_object_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "assigned_object_id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "assigned_object_id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "assigned_object_id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "assigned_object_id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "assigned_object_id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "assigned_object_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "assigned_object_type",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "assigned_object_type__n",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Interface (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Interface (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Interface (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Interface (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "mac_address",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "virtual_machine",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_machine_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vminterface",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "VM interface (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vminterface__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "VM interface (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vminterface_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "VM interface (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vminterface_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "VM interface (ID)",
"explode": true,
"style": "form"
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedMACAddressList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_mac_addresses_create",
"description": "Post a list of MAC address objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MACAddressRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/MACAddressRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MACAddress"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_mac_addresses_bulk_update",
"description": "Put a list of MAC address objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MACAddressRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MACAddressRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MACAddress"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_mac_addresses_bulk_partial_update",
"description": "Patch a list of MAC address objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MACAddressRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MACAddressRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MACAddress"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_mac_addresses_bulk_destroy",
"description": "Delete a list of MAC address objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MACAddressRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MACAddressRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/mac-addresses/{id}/": {
"get": {
"operationId": "dcim_mac_addresses_retrieve",
"description": "Get a MAC address object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this MAC address.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MACAddress"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_mac_addresses_update",
"description": "Put a MAC address object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this MAC address.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MACAddressRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/MACAddressRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MACAddress"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_mac_addresses_partial_update",
"description": "Patch a MAC address object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this MAC address.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedMACAddressRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedMACAddressRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MACAddress"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_mac_addresses_destroy",
"description": "Delete a MAC address object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this MAC address.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/manufacturers/": {
"get": {
"operationId": "dcim_manufacturers_list",
"description": "Get a list of manufacturer objects.",
"parameters": [
{
"in": "query",
"name": "contact",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "slug",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "slug__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedManufacturerList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_manufacturers_create",
"description": "Post a list of manufacturer objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManufacturerRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ManufacturerRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Manufacturer"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_manufacturers_bulk_update",
"description": "Put a list of manufacturer objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ManufacturerRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ManufacturerRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Manufacturer"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_manufacturers_bulk_partial_update",
"description": "Patch a list of manufacturer objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ManufacturerRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ManufacturerRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Manufacturer"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_manufacturers_bulk_destroy",
"description": "Delete a list of manufacturer objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ManufacturerRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ManufacturerRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/manufacturers/{id}/": {
"get": {
"operationId": "dcim_manufacturers_retrieve",
"description": "Get a manufacturer object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this manufacturer.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Manufacturer"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_manufacturers_update",
"description": "Put a manufacturer object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this manufacturer.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManufacturerRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ManufacturerRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Manufacturer"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_manufacturers_partial_update",
"description": "Patch a manufacturer object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this manufacturer.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedManufacturerRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedManufacturerRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Manufacturer"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_manufacturers_destroy",
"description": "Delete a manufacturer object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this manufacturer.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/module-bay-templates/": {
"get": {
"operationId": "dcim_module_bay_templates_list",
"description": "Get a list of module bay template objects.",
"parameters": [
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "label__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "module_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Module type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "module_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Module type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "position",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "position__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "position__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "position__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "position__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "position__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "position__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "position__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "position__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "position__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "position__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "position__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "position__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedModuleBayTemplateList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_module_bay_templates_create",
"description": "Post a list of module bay template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModuleBayTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ModuleBayTemplateRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModuleBayTemplate"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_module_bay_templates_bulk_update",
"description": "Put a list of module bay template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModuleBayTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModuleBayTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModuleBayTemplate"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_module_bay_templates_bulk_partial_update",
"description": "Patch a list of module bay template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModuleBayTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModuleBayTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModuleBayTemplate"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_module_bay_templates_bulk_destroy",
"description": "Delete a list of module bay template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModuleBayTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModuleBayTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/module-bay-templates/{id}/": {
"get": {
"operationId": "dcim_module_bay_templates_retrieve",
"description": "Get a module bay template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this module bay template.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModuleBayTemplate"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_module_bay_templates_update",
"description": "Put a module bay template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this module bay template.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModuleBayTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ModuleBayTemplateRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModuleBayTemplate"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_module_bay_templates_partial_update",
"description": "Patch a module bay template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this module bay template.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedModuleBayTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedModuleBayTemplateRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModuleBayTemplate"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_module_bay_templates_destroy",
"description": "Delete a module bay template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this module bay template.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/module-bays/": {
"get": {
"operationId": "dcim_module_bays_list",
"description": "Get a list of module bay objects.",
"parameters": [
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
},
"description": "Device (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
},
"description": "Device (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "device_status__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device type (model)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device type (model)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "installed_module_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Installed module (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "installed_module_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Installed module (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "label__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "location",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Location (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Location (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Location (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Location (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "module_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Module (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "module_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Module (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "parent_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Parent module bay (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "parent_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Parent module bay (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "position",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "position__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "position__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "position__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "position__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "position__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "position__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "position__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "position__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "position__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "position__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "position__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "position__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "rack",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Rack (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Rack (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Rack (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Rack (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site name (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site name (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "virtual_chassis",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Virtual Chassis",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Virtual Chassis",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual Chassis (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual Chassis (ID)",
"explode": true,
"style": "form"
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedModuleBayList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_module_bays_create",
"description": "Post a list of module bay objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModuleBayRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ModuleBayRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModuleBay"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_module_bays_bulk_update",
"description": "Put a list of module bay objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModuleBayRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModuleBayRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModuleBay"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_module_bays_bulk_partial_update",
"description": "Patch a list of module bay objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModuleBayRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModuleBayRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModuleBay"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_module_bays_bulk_destroy",
"description": "Delete a list of module bay objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModuleBayRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModuleBayRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/module-bays/{id}/": {
"get": {
"operationId": "dcim_module_bays_retrieve",
"description": "Get a module bay object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this module bay.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModuleBay"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_module_bays_update",
"description": "Put a module bay object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this module bay.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModuleBayRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ModuleBayRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModuleBay"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_module_bays_partial_update",
"description": "Patch a module bay object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this module bay.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedModuleBayRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedModuleBayRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModuleBay"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_module_bays_destroy",
"description": "Delete a module bay object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this module bay.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/module-type-profiles/": {
"get": {
"operationId": "dcim_module_type_profiles_list",
"description": "Get a list of module type profile objects.",
"parameters": [
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedModuleTypeProfileList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_module_type_profiles_create",
"description": "Post a list of module type profile objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModuleTypeProfileRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ModuleTypeProfileRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModuleTypeProfile"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_module_type_profiles_bulk_update",
"description": "Put a list of module type profile objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModuleTypeProfileRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModuleTypeProfileRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModuleTypeProfile"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_module_type_profiles_bulk_partial_update",
"description": "Patch a list of module type profile objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModuleTypeProfileRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModuleTypeProfileRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModuleTypeProfile"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_module_type_profiles_bulk_destroy",
"description": "Delete a list of module type profile objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModuleTypeProfileRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModuleTypeProfileRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/module-type-profiles/{id}/": {
"get": {
"operationId": "dcim_module_type_profiles_retrieve",
"description": "Get a module type profile object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this module type profile.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModuleTypeProfile"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_module_type_profiles_update",
"description": "Put a module type profile object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this module type profile.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModuleTypeProfileRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ModuleTypeProfileRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModuleTypeProfile"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_module_type_profiles_partial_update",
"description": "Patch a module type profile object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this module type profile.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedModuleTypeProfileRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedModuleTypeProfileRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModuleTypeProfile"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_module_type_profiles_destroy",
"description": "Delete a module type profile object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this module type profile.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/module-types/": {
"get": {
"operationId": "dcim_module_types_list",
"description": "Get a list of module type objects.",
"parameters": [
{
"in": "query",
"name": "airflow",
"schema": {
"type": "string",
"x-spec-enum-id": "f6e5562e0e98d69d",
"nullable": true,
"enum": [
"front-to-rear",
"left-to-right",
"passive",
"rear-to-front",
"right-to-left",
"side-to-rear"
]
},
"description": "* `front-to-rear` - Front to rear\n* `rear-to-front` - Rear to front\n* `left-to-right` - Left to right\n* `right-to-left` - Right to left\n* `side-to-rear` - Side to rear\n* `passive` - Passive"
},
{
"in": "query",
"name": "console_ports",
"schema": {
"type": "boolean"
},
"description": "Has console ports"
},
{
"in": "query",
"name": "console_server_ports",
"schema": {
"type": "boolean"
},
"description": "Has console server ports"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interfaces",
"schema": {
"type": "boolean"
},
"description": "Has interfaces"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "manufacturer",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Manufacturer (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "manufacturer__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Manufacturer (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "manufacturer_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Manufacturer (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "manufacturer_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Manufacturer (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "model__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "part_number",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_number__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "part_number__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_number__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_number__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_number__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_number__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_number__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_number__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_number__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_number__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_number__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "part_number__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "pass_through_ports",
"schema": {
"type": "boolean"
},
"description": "Has pass-through ports"
},
{
"in": "query",
"name": "power_outlets",
"schema": {
"type": "boolean"
},
"description": "Has power outlets"
},
{
"in": "query",
"name": "power_ports",
"schema": {
"type": "boolean"
},
"description": "Has power ports"
},
{
"in": "query",
"name": "profile",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Profile (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "profile__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Profile (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "profile_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Profile (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "profile_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Profile (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "weight",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "weight__gt",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__gte",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__lt",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__lte",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__n",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight_unit",
"schema": {
"type": "string",
"x-spec-enum-id": "7c1876f422815884",
"nullable": true,
"enum": [
"g",
"kg",
"lb",
"oz"
]
},
"description": "* `kg` - Kilograms\n* `g` - Grams\n* `lb` - Pounds\n* `oz` - Ounces"
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedModuleTypeList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_module_types_create",
"description": "Post a list of module type objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableModuleTypeRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableModuleTypeRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModuleType"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_module_types_bulk_update",
"description": "Put a list of module type objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModuleTypeRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModuleTypeRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModuleType"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_module_types_bulk_partial_update",
"description": "Patch a list of module type objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModuleTypeRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModuleTypeRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModuleType"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_module_types_bulk_destroy",
"description": "Delete a list of module type objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModuleTypeRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModuleTypeRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/module-types/{id}/": {
"get": {
"operationId": "dcim_module_types_retrieve",
"description": "Get a module type object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this module type.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModuleType"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_module_types_update",
"description": "Put a module type object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this module type.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableModuleTypeRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableModuleTypeRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModuleType"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_module_types_partial_update",
"description": "Patch a module type object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this module type.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableModuleTypeRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableModuleTypeRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModuleType"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_module_types_destroy",
"description": "Delete a module type object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this module type.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/modules/": {
"get": {
"operationId": "dcim_modules_list",
"description": "Get a list of module objects.",
"parameters": [
{
"in": "query",
"name": "asset_tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "asset_tag__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
},
"description": "Device (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
},
"description": "Device (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "location",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Location (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Location (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Location (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Location (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "manufacturer",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Manufacturer (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "manufacturer__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Manufacturer (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "manufacturer_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Manufacturer (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "manufacturer_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Manufacturer (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "module_bay_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "module_bay_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "module_type",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Module type (model)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "module_type__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Module type (model)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "module_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Module type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "module_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Module type (ID)",
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "rack",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Rack (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Rack (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Rack (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Rack (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "serial__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site name (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site name (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2217e87d0c3efdda"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "status__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2217e87d0c3efdda"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2217e87d0c3efdda"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2217e87d0c3efdda"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2217e87d0c3efdda"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2217e87d0c3efdda"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2217e87d0c3efdda"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2217e87d0c3efdda"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2217e87d0c3efdda"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2217e87d0c3efdda"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2217e87d0c3efdda"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "2217e87d0c3efdda"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedModuleList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_modules_create",
"description": "Post a list of module objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableModuleRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableModuleRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Module"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_modules_bulk_update",
"description": "Put a list of module objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModuleRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModuleRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Module"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_modules_bulk_partial_update",
"description": "Patch a list of module objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModuleRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModuleRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Module"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_modules_bulk_destroy",
"description": "Delete a list of module objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModuleRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModuleRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/modules/{id}/": {
"get": {
"operationId": "dcim_modules_retrieve",
"description": "Get a module object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this module.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Module"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_modules_update",
"description": "Put a module object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this module.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableModuleRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableModuleRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Module"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_modules_partial_update",
"description": "Patch a module object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this module.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableModuleRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableModuleRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Module"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_modules_destroy",
"description": "Delete a module object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this module.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/platforms/": {
"get": {
"operationId": "dcim_platforms_list",
"description": "Get a list of platform objects.",
"parameters": [
{
"in": "query",
"name": "ancestor",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ancestor__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ancestor_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ancestor_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "available_for_device_type",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "config_template_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Config template (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "config_template_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Config template (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "manufacturer",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Manufacturer (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "manufacturer__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Manufacturer (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "manufacturer_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Manufacturer (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "manufacturer_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Manufacturer (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "parent",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Immediate parent platform (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "parent__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Immediate parent platform (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "parent_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Immediate parent platform (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "parent_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Immediate parent platform (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "slug",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "slug__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedPlatformList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_platforms_create",
"description": "Post a list of platform objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritablePlatformRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritablePlatformRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Platform"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_platforms_bulk_update",
"description": "Put a list of platform objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PlatformRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PlatformRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Platform"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_platforms_bulk_partial_update",
"description": "Patch a list of platform objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PlatformRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PlatformRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Platform"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_platforms_bulk_destroy",
"description": "Delete a list of platform objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PlatformRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PlatformRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/platforms/{id}/": {
"get": {
"operationId": "dcim_platforms_retrieve",
"description": "Get a platform object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this platform.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Platform"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_platforms_update",
"description": "Put a platform object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this platform.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritablePlatformRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritablePlatformRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Platform"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_platforms_partial_update",
"description": "Patch a platform object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this platform.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritablePlatformRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritablePlatformRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Platform"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_platforms_destroy",
"description": "Delete a platform object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this platform.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/power-feeds/": {
"get": {
"operationId": "dcim_power_feeds_list",
"description": "Get a list of power feed objects.",
"parameters": [
{
"in": "query",
"name": "amperage",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "amperage__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "amperage__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "amperage__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "amperage__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "amperage__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "amperage__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "available_power",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "available_power__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "available_power__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "available_power__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "available_power__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "available_power__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "available_power__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cable_end",
"schema": {
"type": "string",
"x-spec-enum-id": "1db84f9b93b261c8",
"nullable": true,
"enum": [
"A",
"B"
]
},
"description": "* `A` - A\n* `B` - B"
},
{
"in": "query",
"name": "cable_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Cable (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cable_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Cable (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cabled",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "connected",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "mark_connected",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "max_utilization",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "max_utilization__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "max_utilization__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "max_utilization__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "max_utilization__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "max_utilization__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "max_utilization__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "occupied",
"schema": {
"type": "boolean"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "phase",
"schema": {
"type": "string",
"x-spec-enum-id": "994bc0696f4df57f",
"enum": [
"single-phase",
"three-phase"
]
},
"description": "* `single-phase` - Single phase\n* `three-phase` - Three-phase"
},
{
"in": "query",
"name": "power_panel_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Power panel (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "power_panel_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Power panel (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "rack_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Rack (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Rack (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site name (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site name (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b77fc919138c12f6"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "status__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b77fc919138c12f6"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b77fc919138c12f6"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b77fc919138c12f6"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b77fc919138c12f6"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b77fc919138c12f6"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b77fc919138c12f6"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b77fc919138c12f6"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b77fc919138c12f6"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b77fc919138c12f6"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b77fc919138c12f6"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b77fc919138c12f6"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "supply",
"schema": {
"type": "string",
"x-spec-enum-id": "1b6d99616ca6412b",
"enum": [
"ac",
"dc"
]
},
"description": "* `ac` - AC\n* `dc` - DC"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type",
"schema": {
"type": "string",
"x-spec-enum-id": "093a164236819eb8",
"enum": [
"primary",
"redundant"
]
},
"description": "* `primary` - Primary\n* `redundant` - Redundant"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "voltage",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "voltage__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "voltage__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "voltage__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "voltage__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "voltage__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "voltage__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedPowerFeedList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_power_feeds_create",
"description": "Post a list of power feed objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritablePowerFeedRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritablePowerFeedRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerFeed"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_power_feeds_bulk_update",
"description": "Put a list of power feed objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerFeedRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerFeedRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerFeed"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_power_feeds_bulk_partial_update",
"description": "Patch a list of power feed objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerFeedRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerFeedRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerFeed"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_power_feeds_bulk_destroy",
"description": "Delete a list of power feed objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerFeedRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerFeedRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/power-feeds/{id}/": {
"get": {
"operationId": "dcim_power_feeds_retrieve",
"description": "Get a power feed object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this power feed.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerFeed"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_power_feeds_update",
"description": "Put a power feed object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this power feed.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritablePowerFeedRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritablePowerFeedRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerFeed"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_power_feeds_partial_update",
"description": "Patch a power feed object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this power feed.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritablePowerFeedRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritablePowerFeedRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerFeed"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_power_feeds_destroy",
"description": "Delete a power feed object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this power feed.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/power-feeds/{id}/trace/": {
"get": {
"operationId": "dcim_power_feeds_trace_retrieve",
"description": "Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this power feed.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerFeed"
}
}
},
"description": ""
}
}
}
},
"/api/dcim/power-outlet-templates/": {
"get": {
"operationId": "dcim_power_outlet_templates_list",
"description": "Get a list of power outlet template objects.",
"parameters": [
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "feed_leg",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a4902339df0b7c06",
"nullable": true
}
},
"description": "Phase (for three-phase feeds)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "feed_leg__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "feed_leg__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a4902339df0b7c06",
"nullable": true
}
},
"description": "Phase (for three-phase feeds)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "feed_leg__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a4902339df0b7c06",
"nullable": true
}
},
"description": "Phase (for three-phase feeds)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "feed_leg__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a4902339df0b7c06",
"nullable": true
}
},
"description": "Phase (for three-phase feeds)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "feed_leg__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a4902339df0b7c06",
"nullable": true
}
},
"description": "Phase (for three-phase feeds)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "feed_leg__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a4902339df0b7c06",
"nullable": true
}
},
"description": "Phase (for three-phase feeds)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "feed_leg__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a4902339df0b7c06",
"nullable": true
}
},
"description": "Phase (for three-phase feeds)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "feed_leg__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a4902339df0b7c06",
"nullable": true
}
},
"description": "Phase (for three-phase feeds)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "feed_leg__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a4902339df0b7c06",
"nullable": true
}
},
"description": "Phase (for three-phase feeds)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "feed_leg__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a4902339df0b7c06",
"nullable": true
}
},
"description": "Phase (for three-phase feeds)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "feed_leg__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a4902339df0b7c06",
"nullable": true
}
},
"description": "Phase (for three-phase feeds)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "feed_leg__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a4902339df0b7c06",
"nullable": true
}
},
"description": "Phase (for three-phase feeds)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "label__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "module_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Module type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "module_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Module type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "power_port_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Power port (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "power_port_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Power port (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "type",
"schema": {
"type": "string",
"x-spec-enum-id": "8f9617d2648ab261",
"nullable": true,
"enum": [
"California Style",
"DC",
"IEC 60309",
"IEC 60320",
"IEC 60906-1",
"ITA/International",
"Molex",
"NEMA (Locking)",
"NEMA (Non-locking)",
"Other",
"Proprietary",
"USB"
]
},
"description": "* `IEC 60320` - [('iec-60320-c5', 'C5'), ('iec-60320-c7', 'C7'), ('iec-60320-c13', 'C13'), ('iec-60320-c15', 'C15'), ('iec-60320-c17', 'C17'), ('iec-60320-c19', 'C19'), ('iec-60320-c21', 'C21')]\n* `IEC 60309` - [('iec-60309-p-n-e-4h', 'P+N+E 4H'), ('iec-60309-p-n-e-6h', 'P+N+E 6H'), ('iec-60309-p-n-e-9h', 'P+N+E 9H'), ('iec-60309-2p-e-4h', '2P+E 4H'), ('iec-60309-2p-e-6h', '2P+E 6H'), ('iec-60309-2p-e-9h', '2P+E 9H'), ('iec-60309-3p-e-4h', '3P+E 4H'), ('iec-60309-3p-e-6h', '3P+E 6H'), ('iec-60309-3p-e-9h', '3P+E 9H'), ('iec-60309-3p-n-e-4h', '3P+N+E 4H'), ('iec-60309-3p-n-e-6h', '3P+N+E 6H'), ('iec-60309-3p-n-e-9h', '3P+N+E 9H')]\n* `IEC 60906-1` - [('iec-60906-1', 'IEC 60906-1'), ('nbr-14136-10a', '2P+T 10A (NBR 14136)'), ('nbr-14136-20a', '2P+T 20A (NBR 14136)')]\n* `NEMA (Non-locking)` - [('nema-1-15r', 'NEMA 1-15R'), ('nema-5-15r', 'NEMA 5-15R'), ('nema-5-20r', 'NEMA 5-20R'), ('nema-5-30r', 'NEMA 5-30R'), ('nema-5-50r', 'NEMA 5-50R'), ('nema-6-15r', 'NEMA 6-15R'), ('nema-6-20r', 'NEMA 6-20R'), ('nema-6-30r', 'NEMA 6-30R'), ('nema-6-50r', 'NEMA 6-50R'), ('nema-10-30r', 'NEMA 10-30R'), ('nema-10-50r', 'NEMA 10-50R'), ('nema-14-20r', 'NEMA 14-20R'), ('nema-14-30r', 'NEMA 14-30R'), ('nema-14-50r', 'NEMA 14-50R'), ('nema-14-60r', 'NEMA 14-60R'), ('nema-15-15r', 'NEMA 15-15R'), ('nema-15-20r', 'NEMA 15-20R'), ('nema-15-30r', 'NEMA 15-30R'), ('nema-15-50r', 'NEMA 15-50R'), ('nema-15-60r', 'NEMA 15-60R')]\n* `NEMA (Locking)` - [('nema-l1-15r', 'NEMA L1-15R'), ('nema-l5-15r', 'NEMA L5-15R'), ('nema-l5-20r', 'NEMA L5-20R'), ('nema-l5-30r', 'NEMA L5-30R'), ('nema-l5-50r', 'NEMA L5-50R'), ('nema-l6-15r', 'NEMA L6-15R'), ('nema-l6-20r', 'NEMA L6-20R'), ('nema-l6-30r', 'NEMA L6-30R'), ('nema-l6-50r', 'NEMA L6-50R'), ('nema-l10-30r', 'NEMA L10-30R'), ('nema-l14-20r', 'NEMA L14-20R'), ('nema-l14-30r', 'NEMA L14-30R'), ('nema-l14-50r', 'NEMA L14-50R'), ('nema-l14-60r', 'NEMA L14-60R'), ('nema-l15-20r', 'NEMA L15-20R'), ('nema-l15-30r', 'NEMA L15-30R'), ('nema-l15-50r', 'NEMA L15-50R'), ('nema-l15-60r', 'NEMA L15-60R'), ('nema-l21-20r', 'NEMA L21-20R'), ('nema-l21-30r', 'NEMA L21-30R'), ('nema-l22-20r', 'NEMA L22-20R'), ('nema-l22-30r', 'NEMA L22-30R')]\n* `California Style` - [('CS6360C', 'CS6360C'), ('CS6364C', 'CS6364C'), ('CS8164C', 'CS8164C'), ('CS8264C', 'CS8264C'), ('CS8364C', 'CS8364C'), ('CS8464C', 'CS8464C')]\n* `ITA/International` - [('ita-e', 'ITA Type E (CEE 7/5)'), ('ita-f', 'ITA Type F (CEE 7/3)'), ('ita-g', 'ITA Type G (BS 1363)'), ('ita-h', 'ITA Type H'), ('ita-i', 'ITA Type I'), ('ita-j', 'ITA Type J'), ('ita-k', 'ITA Type K'), ('ita-l', 'ITA Type L (CEI 23-50)'), ('ita-m', 'ITA Type M (BS 546)'), ('ita-n', 'ITA Type N'), ('ita-o', 'ITA Type O'), ('ita-multistandard', 'ITA Multistandard')]\n* `USB` - [('usb-a', 'USB Type A'), ('usb-micro-b', 'USB Micro B'), ('usb-c', 'USB Type C')]\n* `Molex` - [('molex-micro-fit-1x2', 'Molex Micro-Fit 1x2'), ('molex-micro-fit-2x2', 'Molex Micro-Fit 2x2'), ('molex-micro-fit-2x4', 'Molex Micro-Fit 2x4')]\n* `DC` - [('dc-terminal', 'DC Terminal')]\n* `Proprietary` - [('eaton-c39', 'Eaton C39'), ('hdot-cx', 'HDOT Cx'), ('saf-d-grid', 'Saf-D-Grid'), ('neutrik-powercon-20a', 'Neutrik powerCON (20A)'), ('neutrik-powercon-32a', 'Neutrik powerCON (32A)'), ('neutrik-powercon-true1', 'Neutrik powerCON TRUE1'), ('neutrik-powercon-true1-top', 'Neutrik powerCON TRUE1 TOP'), ('ubiquiti-smartpower', 'Ubiquiti SmartPower')]\n* `Other` - [('hardwired', 'Hardwired'), ('other', 'Other')]"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedPowerOutletTemplateList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_power_outlet_templates_create",
"description": "Post a list of power outlet template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritablePowerOutletTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritablePowerOutletTemplateRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerOutletTemplate"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_power_outlet_templates_bulk_update",
"description": "Put a list of power outlet template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerOutletTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerOutletTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerOutletTemplate"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_power_outlet_templates_bulk_partial_update",
"description": "Patch a list of power outlet template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerOutletTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerOutletTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerOutletTemplate"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_power_outlet_templates_bulk_destroy",
"description": "Delete a list of power outlet template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerOutletTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerOutletTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/power-outlet-templates/{id}/": {
"get": {
"operationId": "dcim_power_outlet_templates_retrieve",
"description": "Get a power outlet template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this power outlet template.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerOutletTemplate"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_power_outlet_templates_update",
"description": "Put a power outlet template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this power outlet template.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritablePowerOutletTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritablePowerOutletTemplateRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerOutletTemplate"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_power_outlet_templates_partial_update",
"description": "Patch a power outlet template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this power outlet template.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritablePowerOutletTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritablePowerOutletTemplateRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerOutletTemplate"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_power_outlet_templates_destroy",
"description": "Delete a power outlet template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this power outlet template.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/power-outlets/": {
"get": {
"operationId": "dcim_power_outlets_list",
"description": "Get a list of power outlet objects.",
"parameters": [
{
"in": "query",
"name": "cable_end",
"schema": {
"type": "string",
"x-spec-enum-id": "1db84f9b93b261c8",
"nullable": true,
"enum": [
"A",
"B"
]
},
"description": "* `A` - A\n* `B` - B"
},
{
"in": "query",
"name": "cable_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Cable (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cable_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Cable (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cabled",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "color",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "color__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "connected",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
},
"description": "Device (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
},
"description": "Device (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "device_status__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device type (model)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device type (model)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "feed_leg",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a4902339df0b7c06",
"nullable": true
}
},
"description": "Phase (for three-phase feeds)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "feed_leg__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "feed_leg__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a4902339df0b7c06",
"nullable": true
}
},
"description": "Phase (for three-phase feeds)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "feed_leg__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a4902339df0b7c06",
"nullable": true
}
},
"description": "Phase (for three-phase feeds)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "feed_leg__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a4902339df0b7c06",
"nullable": true
}
},
"description": "Phase (for three-phase feeds)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "feed_leg__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a4902339df0b7c06",
"nullable": true
}
},
"description": "Phase (for three-phase feeds)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "feed_leg__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a4902339df0b7c06",
"nullable": true
}
},
"description": "Phase (for three-phase feeds)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "feed_leg__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a4902339df0b7c06",
"nullable": true
}
},
"description": "Phase (for three-phase feeds)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "feed_leg__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a4902339df0b7c06",
"nullable": true
}
},
"description": "Phase (for three-phase feeds)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "feed_leg__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a4902339df0b7c06",
"nullable": true
}
},
"description": "Phase (for three-phase feeds)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "feed_leg__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a4902339df0b7c06",
"nullable": true
}
},
"description": "Phase (for three-phase feeds)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "feed_leg__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a4902339df0b7c06",
"nullable": true
}
},
"description": "Phase (for three-phase feeds)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "feed_leg__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a4902339df0b7c06",
"nullable": true
}
},
"description": "Phase (for three-phase feeds)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "label__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "location",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Location (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Location (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Location (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Location (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mark_connected",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "module_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Module (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "module_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Module (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "occupied",
"schema": {
"type": "boolean"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "power_port_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Power port (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "power_port_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Power port (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "rack",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Rack (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Rack (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Rack (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Rack (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site name (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site name (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "1024f7deaed962d7"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "status__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "1024f7deaed962d7"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "1024f7deaed962d7"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "1024f7deaed962d7"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "1024f7deaed962d7"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "1024f7deaed962d7"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "1024f7deaed962d7"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "1024f7deaed962d7"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "1024f7deaed962d7"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "1024f7deaed962d7"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "1024f7deaed962d7"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "1024f7deaed962d7"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8f9617d2648ab261",
"nullable": true
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "type__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8f9617d2648ab261",
"nullable": true
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8f9617d2648ab261",
"nullable": true
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8f9617d2648ab261",
"nullable": true
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8f9617d2648ab261",
"nullable": true
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8f9617d2648ab261",
"nullable": true
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8f9617d2648ab261",
"nullable": true
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8f9617d2648ab261",
"nullable": true
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8f9617d2648ab261",
"nullable": true
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8f9617d2648ab261",
"nullable": true
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8f9617d2648ab261",
"nullable": true
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8f9617d2648ab261",
"nullable": true
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "virtual_chassis",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Virtual Chassis",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Virtual Chassis",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual Chassis (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual Chassis (ID)",
"explode": true,
"style": "form"
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedPowerOutletList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_power_outlets_create",
"description": "Post a list of power outlet objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritablePowerOutletRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritablePowerOutletRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerOutlet"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_power_outlets_bulk_update",
"description": "Put a list of power outlet objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerOutletRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerOutletRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerOutlet"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_power_outlets_bulk_partial_update",
"description": "Patch a list of power outlet objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerOutletRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerOutletRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerOutlet"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_power_outlets_bulk_destroy",
"description": "Delete a list of power outlet objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerOutletRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerOutletRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/power-outlets/{id}/": {
"get": {
"operationId": "dcim_power_outlets_retrieve",
"description": "Get a power outlet object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this power outlet.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerOutlet"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_power_outlets_update",
"description": "Put a power outlet object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this power outlet.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritablePowerOutletRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritablePowerOutletRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerOutlet"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_power_outlets_partial_update",
"description": "Patch a power outlet object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this power outlet.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritablePowerOutletRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritablePowerOutletRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerOutlet"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_power_outlets_destroy",
"description": "Delete a power outlet object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this power outlet.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/power-outlets/{id}/trace/": {
"get": {
"operationId": "dcim_power_outlets_trace_retrieve",
"description": "Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this power outlet.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerOutlet"
}
}
},
"description": ""
}
}
}
},
"/api/dcim/power-panels/": {
"get": {
"operationId": "dcim_power_panels_list",
"description": "Get a list of power panel objects.",
"parameters": [
{
"in": "query",
"name": "contact",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "location_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "region",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site name (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site name (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedPowerPanelList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_power_panels_create",
"description": "Post a list of power panel objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerPanelRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PowerPanelRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerPanel"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_power_panels_bulk_update",
"description": "Put a list of power panel objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerPanelRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerPanelRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerPanel"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_power_panels_bulk_partial_update",
"description": "Patch a list of power panel objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerPanelRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerPanelRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerPanel"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_power_panels_bulk_destroy",
"description": "Delete a list of power panel objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerPanelRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerPanelRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/power-panels/{id}/": {
"get": {
"operationId": "dcim_power_panels_retrieve",
"description": "Get a power panel object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this power panel.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerPanel"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_power_panels_update",
"description": "Put a power panel object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this power panel.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerPanelRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PowerPanelRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerPanel"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_power_panels_partial_update",
"description": "Patch a power panel object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this power panel.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedPowerPanelRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedPowerPanelRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerPanel"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_power_panels_destroy",
"description": "Delete a power panel object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this power panel.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/power-port-templates/": {
"get": {
"operationId": "dcim_power_port_templates_list",
"description": "Get a list of power port template objects.",
"parameters": [
{
"in": "query",
"name": "allocated_draw",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "allocated_draw__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "allocated_draw__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "allocated_draw__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "allocated_draw__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "allocated_draw__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "allocated_draw__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "label__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "maximum_draw",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "maximum_draw__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "maximum_draw__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "maximum_draw__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "maximum_draw__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "maximum_draw__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "maximum_draw__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "module_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Module type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "module_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Module type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "type",
"schema": {
"type": "string",
"x-spec-enum-id": "292850be2c08f7df",
"nullable": true,
"enum": [
"California Style",
"DC",
"IEC 60309",
"IEC 60320",
"IEC 60906-1",
"International/ITA",
"Molex",
"NEMA (Locking)",
"NEMA (Non-locking)",
"Other",
"Proprietary",
"USB"
]
},
"description": "* `IEC 60320` - [('iec-60320-c6', 'C6'), ('iec-60320-c8', 'C8'), ('iec-60320-c14', 'C14'), ('iec-60320-c16', 'C16'), ('iec-60320-c18', 'C18'), ('iec-60320-c20', 'C20'), ('iec-60320-c22', 'C22')]\n* `IEC 60309` - [('iec-60309-p-n-e-4h', 'P+N+E 4H'), ('iec-60309-p-n-e-6h', 'P+N+E 6H'), ('iec-60309-p-n-e-9h', 'P+N+E 9H'), ('iec-60309-2p-e-4h', '2P+E 4H'), ('iec-60309-2p-e-6h', '2P+E 6H'), ('iec-60309-2p-e-9h', '2P+E 9H'), ('iec-60309-3p-e-4h', '3P+E 4H'), ('iec-60309-3p-e-6h', '3P+E 6H'), ('iec-60309-3p-e-9h', '3P+E 9H'), ('iec-60309-3p-n-e-4h', '3P+N+E 4H'), ('iec-60309-3p-n-e-6h', '3P+N+E 6H'), ('iec-60309-3p-n-e-9h', '3P+N+E 9H')]\n* `IEC 60906-1` - [('iec-60906-1', 'IEC 60906-1'), ('nbr-14136-10a', '2P+T 10A (NBR 14136)'), ('nbr-14136-20a', '2P+T 20A (NBR 14136)')]\n* `NEMA (Non-locking)` - [('nema-1-15p', 'NEMA 1-15P'), ('nema-5-15p', 'NEMA 5-15P'), ('nema-5-20p', 'NEMA 5-20P'), ('nema-5-30p', 'NEMA 5-30P'), ('nema-5-50p', 'NEMA 5-50P'), ('nema-6-15p', 'NEMA 6-15P'), ('nema-6-20p', 'NEMA 6-20P'), ('nema-6-30p', 'NEMA 6-30P'), ('nema-6-50p', 'NEMA 6-50P'), ('nema-10-30p', 'NEMA 10-30P'), ('nema-10-50p', 'NEMA 10-50P'), ('nema-14-20p', 'NEMA 14-20P'), ('nema-14-30p', 'NEMA 14-30P'), ('nema-14-50p', 'NEMA 14-50P'), ('nema-14-60p', 'NEMA 14-60P'), ('nema-15-15p', 'NEMA 15-15P'), ('nema-15-20p', 'NEMA 15-20P'), ('nema-15-30p', 'NEMA 15-30P'), ('nema-15-50p', 'NEMA 15-50P'), ('nema-15-60p', 'NEMA 15-60P')]\n* `NEMA (Locking)` - [('nema-l1-15p', 'NEMA L1-15P'), ('nema-l5-15p', 'NEMA L5-15P'), ('nema-l5-20p', 'NEMA L5-20P'), ('nema-l5-30p', 'NEMA L5-30P'), ('nema-l5-50p', 'NEMA L5-50P'), ('nema-l6-15p', 'NEMA L6-15P'), ('nema-l6-20p', 'NEMA L6-20P'), ('nema-l6-30p', 'NEMA L6-30P'), ('nema-l6-50p', 'NEMA L6-50P'), ('nema-l10-30p', 'NEMA L10-30P'), ('nema-l14-20p', 'NEMA L14-20P'), ('nema-l14-30p', 'NEMA L14-30P'), ('nema-l14-50p', 'NEMA L14-50P'), ('nema-l14-60p', 'NEMA L14-60P'), ('nema-l15-20p', 'NEMA L15-20P'), ('nema-l15-30p', 'NEMA L15-30P'), ('nema-l15-50p', 'NEMA L15-50P'), ('nema-l15-60p', 'NEMA L15-60P'), ('nema-l21-20p', 'NEMA L21-20P'), ('nema-l21-30p', 'NEMA L21-30P'), ('nema-l22-20p', 'NEMA L22-20P'), ('nema-l22-30p', 'NEMA L22-30P')]\n* `California Style` - [('cs6361c', 'CS6361C'), ('cs6365c', 'CS6365C'), ('cs8165c', 'CS8165C'), ('cs8265c', 'CS8265C'), ('cs8365c', 'CS8365C'), ('cs8465c', 'CS8465C')]\n* `International/ITA` - [('ita-c', 'ITA Type C (CEE 7/16)'), ('ita-e', 'ITA Type E (CEE 7/6)'), ('ita-f', 'ITA Type F (CEE 7/4)'), ('ita-ef', 'ITA Type E/F (CEE 7/7)'), ('ita-g', 'ITA Type G (BS 1363)'), ('ita-h', 'ITA Type H'), ('ita-i', 'ITA Type I'), ('ita-j', 'ITA Type J'), ('ita-k', 'ITA Type K'), ('ita-l', 'ITA Type L (CEI 23-50)'), ('ita-m', 'ITA Type M (BS 546)'), ('ita-n', 'ITA Type N'), ('ita-o', 'ITA Type O')]\n* `USB` - [('usb-a', 'USB Type A'), ('usb-b', 'USB Type B'), ('usb-c', 'USB Type C'), ('usb-mini-a', 'USB Mini A'), ('usb-mini-b', 'USB Mini B'), ('usb-micro-a', 'USB Micro A'), ('usb-micro-b', 'USB Micro B'), ('usb-micro-ab', 'USB Micro AB'), ('usb-3-b', 'USB 3.0 Type B'), ('usb-3-micro-b', 'USB 3.0 Micro B')]\n* `Molex` - [('molex-micro-fit-1x2', 'Molex Micro-Fit 1x2'), ('molex-micro-fit-2x2', 'Molex Micro-Fit 2x2'), ('molex-micro-fit-2x4', 'Molex Micro-Fit 2x4')]\n* `DC` - [('dc-terminal', 'DC Terminal')]\n* `Proprietary` - [('saf-d-grid', 'Saf-D-Grid'), ('neutrik-powercon-20', 'Neutrik powerCON (20A)'), ('neutrik-powercon-32', 'Neutrik powerCON (32A)'), ('neutrik-powercon-true1', 'Neutrik powerCON TRUE1'), ('neutrik-powercon-true1-top', 'Neutrik powerCON TRUE1 TOP'), ('ubiquiti-smartpower', 'Ubiquiti SmartPower')]\n* `Other` - [('hardwired', 'Hardwired'), ('other', 'Other')]"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedPowerPortTemplateList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_power_port_templates_create",
"description": "Post a list of power port template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritablePowerPortTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritablePowerPortTemplateRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerPortTemplate"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_power_port_templates_bulk_update",
"description": "Put a list of power port template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerPortTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerPortTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerPortTemplate"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_power_port_templates_bulk_partial_update",
"description": "Patch a list of power port template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerPortTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerPortTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerPortTemplate"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_power_port_templates_bulk_destroy",
"description": "Delete a list of power port template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerPortTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerPortTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/power-port-templates/{id}/": {
"get": {
"operationId": "dcim_power_port_templates_retrieve",
"description": "Get a power port template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this power port template.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerPortTemplate"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_power_port_templates_update",
"description": "Put a power port template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this power port template.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritablePowerPortTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritablePowerPortTemplateRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerPortTemplate"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_power_port_templates_partial_update",
"description": "Patch a power port template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this power port template.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritablePowerPortTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritablePowerPortTemplateRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerPortTemplate"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_power_port_templates_destroy",
"description": "Delete a power port template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this power port template.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/power-ports/": {
"get": {
"operationId": "dcim_power_ports_list",
"description": "Get a list of power port objects.",
"parameters": [
{
"in": "query",
"name": "allocated_draw",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "allocated_draw__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "allocated_draw__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "allocated_draw__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "allocated_draw__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "allocated_draw__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "allocated_draw__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cable_end",
"schema": {
"type": "string",
"x-spec-enum-id": "1db84f9b93b261c8",
"nullable": true,
"enum": [
"A",
"B"
]
},
"description": "* `A` - A\n* `B` - B"
},
{
"in": "query",
"name": "cable_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Cable (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cable_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Cable (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cabled",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "connected",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
},
"description": "Device (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
},
"description": "Device (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "device_status__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device type (model)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device type (model)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "label__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "location",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Location (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Location (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Location (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Location (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mark_connected",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "maximum_draw",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "maximum_draw__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "maximum_draw__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "maximum_draw__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "maximum_draw__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "maximum_draw__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "maximum_draw__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "module_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Module (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "module_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Module (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "occupied",
"schema": {
"type": "boolean"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "rack",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Rack (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Rack (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Rack (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Rack (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site name (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site name (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "292850be2c08f7df",
"nullable": true
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "type__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "292850be2c08f7df",
"nullable": true
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "292850be2c08f7df",
"nullable": true
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "292850be2c08f7df",
"nullable": true
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "292850be2c08f7df",
"nullable": true
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "292850be2c08f7df",
"nullable": true
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "292850be2c08f7df",
"nullable": true
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "292850be2c08f7df",
"nullable": true
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "292850be2c08f7df",
"nullable": true
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "292850be2c08f7df",
"nullable": true
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "292850be2c08f7df",
"nullable": true
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "292850be2c08f7df",
"nullable": true
}
},
"description": "Physical port type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "virtual_chassis",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Virtual Chassis",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Virtual Chassis",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual Chassis (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual Chassis (ID)",
"explode": true,
"style": "form"
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedPowerPortList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_power_ports_create",
"description": "Post a list of power port objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritablePowerPortRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritablePowerPortRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerPort"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_power_ports_bulk_update",
"description": "Put a list of power port objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerPortRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerPortRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerPort"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_power_ports_bulk_partial_update",
"description": "Patch a list of power port objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerPortRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerPortRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerPort"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_power_ports_bulk_destroy",
"description": "Delete a list of power port objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerPortRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerPortRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/power-ports/{id}/": {
"get": {
"operationId": "dcim_power_ports_retrieve",
"description": "Get a power port object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this power port.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerPort"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_power_ports_update",
"description": "Put a power port object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this power port.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritablePowerPortRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritablePowerPortRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerPort"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_power_ports_partial_update",
"description": "Patch a power port object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this power port.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritablePowerPortRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritablePowerPortRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerPort"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_power_ports_destroy",
"description": "Delete a power port object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this power port.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/power-ports/{id}/trace/": {
"get": {
"operationId": "dcim_power_ports_trace_retrieve",
"description": "Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this power port.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PowerPort"
}
}
},
"description": ""
}
}
}
},
"/api/dcim/rack-reservations/": {
"get": {
"operationId": "dcim_rack_reservations_list",
"description": "Get a list of rack reservation objects.",
"parameters": [
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "location",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "rack_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Rack (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Rack (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b62013475549e423"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "status__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b62013475549e423"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b62013475549e423"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b62013475549e423"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b62013475549e423"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b62013475549e423"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b62013475549e423"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b62013475549e423"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b62013475549e423"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b62013475549e423"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b62013475549e423"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b62013475549e423"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "unit",
"schema": {
"type": "number"
}
},
{
"in": "query",
"name": "unit__empty",
"schema": {
"type": "number"
}
},
{
"in": "query",
"name": "unit__gt",
"schema": {
"type": "number"
}
},
{
"in": "query",
"name": "unit__gte",
"schema": {
"type": "number"
}
},
{
"in": "query",
"name": "unit__lt",
"schema": {
"type": "number"
}
},
{
"in": "query",
"name": "unit__lte",
"schema": {
"type": "number"
}
},
{
"in": "query",
"name": "unit__n",
"schema": {
"type": "number"
}
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "user",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "User (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "user__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "User (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "user_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "User (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "user_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "User (ID)",
"explode": true,
"style": "form"
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedRackReservationList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_rack_reservations_create",
"description": "Post a list of rack reservation objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableRackReservationRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableRackReservationRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RackReservation"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_rack_reservations_bulk_update",
"description": "Put a list of rack reservation objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RackReservationRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RackReservationRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RackReservation"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_rack_reservations_bulk_partial_update",
"description": "Patch a list of rack reservation objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RackReservationRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RackReservationRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RackReservation"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_rack_reservations_bulk_destroy",
"description": "Delete a list of rack reservation objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RackReservationRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RackReservationRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/rack-reservations/{id}/": {
"get": {
"operationId": "dcim_rack_reservations_retrieve",
"description": "Get a rack reservation object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this rack reservation.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RackReservation"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_rack_reservations_update",
"description": "Put a rack reservation object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this rack reservation.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableRackReservationRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableRackReservationRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RackReservation"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_rack_reservations_partial_update",
"description": "Patch a rack reservation object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this rack reservation.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableRackReservationRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableRackReservationRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RackReservation"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_rack_reservations_destroy",
"description": "Delete a rack reservation object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this rack reservation.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/rack-roles/": {
"get": {
"operationId": "dcim_rack_roles_list",
"description": "Get a list of rack role objects.",
"parameters": [
{
"in": "query",
"name": "color",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "color__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "slug",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "slug__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedRackRoleList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_rack_roles_create",
"description": "Post a list of rack role objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RackRoleRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/RackRoleRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RackRole"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_rack_roles_bulk_update",
"description": "Put a list of rack role objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RackRoleRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RackRoleRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RackRole"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_rack_roles_bulk_partial_update",
"description": "Patch a list of rack role objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RackRoleRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RackRoleRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RackRole"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_rack_roles_bulk_destroy",
"description": "Delete a list of rack role objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RackRoleRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RackRoleRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/rack-roles/{id}/": {
"get": {
"operationId": "dcim_rack_roles_retrieve",
"description": "Get a rack role object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this rack role.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RackRole"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_rack_roles_update",
"description": "Put a rack role object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this rack role.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RackRoleRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/RackRoleRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RackRole"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_rack_roles_partial_update",
"description": "Patch a rack role object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this rack role.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedRackRoleRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedRackRoleRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RackRole"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_rack_roles_destroy",
"description": "Delete a rack role object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this rack role.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/rack-types/": {
"get": {
"operationId": "dcim_rack_types_list",
"description": "Get a list of rack type objects.",
"parameters": [
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "desc_units",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "form_factor",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e32aaa89a223f2ea"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "form_factor__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "form_factor__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e32aaa89a223f2ea"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "form_factor__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e32aaa89a223f2ea"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "form_factor__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e32aaa89a223f2ea"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "form_factor__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e32aaa89a223f2ea"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "form_factor__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e32aaa89a223f2ea"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "form_factor__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e32aaa89a223f2ea"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "form_factor__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e32aaa89a223f2ea"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "form_factor__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e32aaa89a223f2ea"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "form_factor__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e32aaa89a223f2ea"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "form_factor__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e32aaa89a223f2ea"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "form_factor__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e32aaa89a223f2ea"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "manufacturer",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Manufacturer (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "manufacturer__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Manufacturer (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "manufacturer_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Manufacturer (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "manufacturer_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Manufacturer (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "max_weight",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "max_weight__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "max_weight__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "max_weight__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "max_weight__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "max_weight__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "max_weight__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "model__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "mounting_depth",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mounting_depth__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "mounting_depth__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mounting_depth__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mounting_depth__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mounting_depth__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mounting_depth__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "outer_depth",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "outer_depth__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "outer_depth__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "outer_depth__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "outer_depth__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "outer_depth__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "outer_depth__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "outer_height",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "outer_height__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "outer_height__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "outer_height__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "outer_height__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "outer_height__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "outer_height__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "outer_unit",
"schema": {
"type": "string",
"x-spec-enum-id": "86a846b6c40f495e",
"nullable": true,
"enum": [
"in",
"mm"
]
},
"description": "* `mm` - Millimeters\n* `in` - Inches"
},
{
"in": "query",
"name": "outer_width",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "outer_width__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "outer_width__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "outer_width__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "outer_width__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "outer_width__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "outer_width__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "slug",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "slug__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "starting_unit",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "starting_unit__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "starting_unit__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "starting_unit__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "starting_unit__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "starting_unit__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "starting_unit__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "u_height",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "u_height__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "u_height__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "u_height__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "u_height__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "u_height__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "u_height__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "weight",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "weight__gt",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__gte",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__lt",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__lte",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__n",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight_unit",
"schema": {
"type": "string",
"x-spec-enum-id": "7c1876f422815884",
"nullable": true,
"enum": [
"g",
"kg",
"lb",
"oz"
]
},
"description": "* `kg` - Kilograms\n* `g` - Grams\n* `lb` - Pounds\n* `oz` - Ounces"
},
{
"in": "query",
"name": "width",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "9b322795f297a9c3"
}
},
"description": "Rail-to-rail width",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "width__ic",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "9b322795f297a9c3"
}
},
"description": "Rail-to-rail width",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "width__ie",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "9b322795f297a9c3"
}
},
"description": "Rail-to-rail width",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "width__iew",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "9b322795f297a9c3"
}
},
"description": "Rail-to-rail width",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "width__iregex",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "9b322795f297a9c3"
}
},
"description": "Rail-to-rail width",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "width__isw",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "9b322795f297a9c3"
}
},
"description": "Rail-to-rail width",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "width__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "9b322795f297a9c3"
}
},
"description": "Rail-to-rail width",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "width__nic",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "9b322795f297a9c3"
}
},
"description": "Rail-to-rail width",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "width__nie",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "9b322795f297a9c3"
}
},
"description": "Rail-to-rail width",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "width__niew",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "9b322795f297a9c3"
}
},
"description": "Rail-to-rail width",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "width__nisw",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "9b322795f297a9c3"
}
},
"description": "Rail-to-rail width",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "width__regex",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "9b322795f297a9c3"
}
},
"description": "Rail-to-rail width",
"explode": true,
"style": "form"
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedRackTypeList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_rack_types_create",
"description": "Post a list of rack type objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableRackTypeRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableRackTypeRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RackType"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_rack_types_bulk_update",
"description": "Put a list of rack type objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RackTypeRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RackTypeRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RackType"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_rack_types_bulk_partial_update",
"description": "Patch a list of rack type objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RackTypeRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RackTypeRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RackType"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_rack_types_bulk_destroy",
"description": "Delete a list of rack type objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RackTypeRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RackTypeRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/rack-types/{id}/": {
"get": {
"operationId": "dcim_rack_types_retrieve",
"description": "Get a rack type object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this rack type.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RackType"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_rack_types_update",
"description": "Put a rack type object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this rack type.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableRackTypeRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableRackTypeRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RackType"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_rack_types_partial_update",
"description": "Patch a rack type object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this rack type.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableRackTypeRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableRackTypeRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RackType"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_rack_types_destroy",
"description": "Delete a rack type object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this rack type.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/racks/": {
"get": {
"operationId": "dcim_racks_list",
"description": "Get a list of rack objects.",
"parameters": [
{
"in": "query",
"name": "airflow",
"schema": {
"type": "string",
"x-spec-enum-id": "a784734d07ef1b3c",
"nullable": true,
"enum": [
"front-to-rear",
"rear-to-front"
]
},
"description": "* `front-to-rear` - Front to rear\n* `rear-to-front` - Rear to front"
},
{
"in": "query",
"name": "asset_tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "asset_tag__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asset_tag__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "desc_units",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "facility_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "facility_id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "facility_id__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "facility_id__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "facility_id__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "facility_id__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "facility_id__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "facility_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "facility_id__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "facility_id__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "facility_id__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "facility_id__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "facility_id__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "form_factor",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e32aaa89a223f2ea",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "form_factor__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "form_factor__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e32aaa89a223f2ea",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "form_factor__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e32aaa89a223f2ea",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "form_factor__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e32aaa89a223f2ea",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "form_factor__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e32aaa89a223f2ea",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "form_factor__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e32aaa89a223f2ea",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "form_factor__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e32aaa89a223f2ea",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "form_factor__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e32aaa89a223f2ea",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "form_factor__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e32aaa89a223f2ea",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "form_factor__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e32aaa89a223f2ea",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "form_factor__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e32aaa89a223f2ea",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "form_factor__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e32aaa89a223f2ea",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "location",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "manufacturer",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Manufacturer (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "manufacturer__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Manufacturer (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "manufacturer_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Manufacturer (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "manufacturer_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Manufacturer (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "max_weight",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "max_weight__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "max_weight__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "max_weight__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "max_weight__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "max_weight__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "max_weight__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "mounting_depth",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mounting_depth__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "mounting_depth__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mounting_depth__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mounting_depth__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mounting_depth__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mounting_depth__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "outer_depth",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "outer_depth__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "outer_depth__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "outer_depth__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "outer_depth__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "outer_depth__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "outer_depth__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "outer_height",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "outer_height__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "outer_height__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "outer_height__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "outer_height__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "outer_height__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "outer_height__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "outer_unit",
"schema": {
"type": "string",
"x-spec-enum-id": "86a846b6c40f495e",
"nullable": true,
"enum": [
"in",
"mm"
]
},
"description": "* `mm` - Millimeters\n* `in` - Inches"
},
{
"in": "query",
"name": "outer_width",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "outer_width__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "outer_width__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "outer_width__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "outer_width__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "outer_width__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "outer_width__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "rack_type",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Rack type (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack_type__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Rack type (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Rack type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Rack type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "serial__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "starting_unit",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "starting_unit__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "starting_unit__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "starting_unit__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "starting_unit__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "starting_unit__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "starting_unit__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0c556d55dc1baa13"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "status__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0c556d55dc1baa13"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0c556d55dc1baa13"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0c556d55dc1baa13"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0c556d55dc1baa13"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0c556d55dc1baa13"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0c556d55dc1baa13"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0c556d55dc1baa13"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0c556d55dc1baa13"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0c556d55dc1baa13"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0c556d55dc1baa13"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0c556d55dc1baa13"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "u_height",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "u_height__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "u_height__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "u_height__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "u_height__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "u_height__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "u_height__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "weight",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "weight__gt",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__gte",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__lt",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__lte",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__n",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight_unit",
"schema": {
"type": "string",
"x-spec-enum-id": "7c1876f422815884",
"nullable": true,
"enum": [
"g",
"kg",
"lb",
"oz"
]
},
"description": "* `kg` - Kilograms\n* `g` - Grams\n* `lb` - Pounds\n* `oz` - Ounces"
},
{
"in": "query",
"name": "width",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "9b322795f297a9c3"
}
},
"description": "Rail-to-rail width",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "width__ic",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "9b322795f297a9c3"
}
},
"description": "Rail-to-rail width",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "width__ie",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "9b322795f297a9c3"
}
},
"description": "Rail-to-rail width",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "width__iew",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "9b322795f297a9c3"
}
},
"description": "Rail-to-rail width",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "width__iregex",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "9b322795f297a9c3"
}
},
"description": "Rail-to-rail width",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "width__isw",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "9b322795f297a9c3"
}
},
"description": "Rail-to-rail width",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "width__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "9b322795f297a9c3"
}
},
"description": "Rail-to-rail width",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "width__nic",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "9b322795f297a9c3"
}
},
"description": "Rail-to-rail width",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "width__nie",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "9b322795f297a9c3"
}
},
"description": "Rail-to-rail width",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "width__niew",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "9b322795f297a9c3"
}
},
"description": "Rail-to-rail width",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "width__nisw",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "9b322795f297a9c3"
}
},
"description": "Rail-to-rail width",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "width__regex",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "9b322795f297a9c3"
}
},
"description": "Rail-to-rail width",
"explode": true,
"style": "form"
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedRackList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_racks_create",
"description": "Post a list of rack objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableRackRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableRackRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Rack"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_racks_bulk_update",
"description": "Put a list of rack objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RackRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RackRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Rack"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_racks_bulk_partial_update",
"description": "Patch a list of rack objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RackRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RackRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Rack"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_racks_bulk_destroy",
"description": "Delete a list of rack objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RackRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RackRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/racks/{id}/": {
"get": {
"operationId": "dcim_racks_retrieve",
"description": "Get a rack object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this rack.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Rack"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_racks_update",
"description": "Put a rack object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this rack.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableRackRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableRackRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Rack"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_racks_partial_update",
"description": "Patch a rack object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this rack.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableRackRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableRackRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Rack"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_racks_destroy",
"description": "Delete a rack object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this rack.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/racks/{id}/elevation/": {
"get": {
"operationId": "dcim_racks_elevation_retrieve",
"description": "Rack elevation representing the list of rack units. Also supports rendering the elevation as an SVG.",
"parameters": [
{
"in": "query",
"name": "exclude",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "expand_devices",
"schema": {
"type": "boolean",
"default": true
}
},
{
"in": "query",
"name": "face",
"schema": {
"enum": [
"front",
"rear"
],
"type": "string",
"x-spec-enum-id": "d2fb9b3f75158b83",
"default": "front",
"minLength": 1
},
"description": "* `front` - Front\n* `rear` - Rear"
},
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this rack.",
"required": true
},
{
"in": "query",
"name": "include_images",
"schema": {
"type": "boolean",
"default": true
}
},
{
"in": "query",
"name": "legend_width",
"schema": {
"type": "integer",
"default": 30
}
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "margin_width",
"schema": {
"type": "integer",
"default": 15
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string",
"minLength": 1
}
},
{
"in": "query",
"name": "render",
"schema": {
"enum": [
"json",
"svg"
],
"type": "string",
"x-spec-enum-id": "09901a5ff13ba07a",
"default": "json",
"minLength": 1
},
"description": "* `json` - json\n* `svg` - svg"
},
{
"in": "query",
"name": "unit_height",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "unit_width",
"schema": {
"type": "integer"
}
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedRackUnitList"
}
}
},
"description": ""
}
}
}
},
"/api/dcim/rear-port-templates/": {
"get": {
"operationId": "dcim_rear_port_templates_list",
"description": "Get a list of rear port template objects.",
"parameters": [
{
"in": "query",
"name": "color",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "color__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "label__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "module_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Module type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "module_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Module type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "positions",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "positions__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "positions__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "positions__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "positions__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "positions__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "positions__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "type",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ea67ae8ba4602f8a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "type__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ea67ae8ba4602f8a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ea67ae8ba4602f8a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ea67ae8ba4602f8a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ea67ae8ba4602f8a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ea67ae8ba4602f8a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ea67ae8ba4602f8a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ea67ae8ba4602f8a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ea67ae8ba4602f8a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ea67ae8ba4602f8a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ea67ae8ba4602f8a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ea67ae8ba4602f8a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedRearPortTemplateList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_rear_port_templates_create",
"description": "Post a list of rear port template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableRearPortTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableRearPortTemplateRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RearPortTemplate"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_rear_port_templates_bulk_update",
"description": "Put a list of rear port template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RearPortTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RearPortTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RearPortTemplate"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_rear_port_templates_bulk_partial_update",
"description": "Patch a list of rear port template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RearPortTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RearPortTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RearPortTemplate"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_rear_port_templates_bulk_destroy",
"description": "Delete a list of rear port template objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RearPortTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RearPortTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/rear-port-templates/{id}/": {
"get": {
"operationId": "dcim_rear_port_templates_retrieve",
"description": "Get a rear port template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this rear port template.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RearPortTemplate"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_rear_port_templates_update",
"description": "Put a rear port template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this rear port template.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableRearPortTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableRearPortTemplateRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RearPortTemplate"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_rear_port_templates_partial_update",
"description": "Patch a rear port template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this rear port template.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableRearPortTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableRearPortTemplateRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RearPortTemplate"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_rear_port_templates_destroy",
"description": "Delete a rear port template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this rear port template.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/rear-ports/": {
"get": {
"operationId": "dcim_rear_ports_list",
"description": "Get a list of rear port objects.",
"parameters": [
{
"in": "query",
"name": "cable_end",
"schema": {
"type": "string",
"x-spec-enum-id": "1db84f9b93b261c8",
"nullable": true,
"enum": [
"A",
"B"
]
},
"description": "* `A` - A\n* `B` - B"
},
{
"in": "query",
"name": "cable_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Cable (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cable_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Cable (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cabled",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "color",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "color__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
},
"description": "Device (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
},
"description": "Device (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "device_status__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_status__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8d8971779f16ee18"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device type (model)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Device type (model)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "label__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "location",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Location (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Location (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Location (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Location (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mark_connected",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "module_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Module (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "module_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Module (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "occupied",
"schema": {
"type": "boolean"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "positions",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "positions__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "positions__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "positions__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "positions__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "positions__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "positions__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "rack",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Rack (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Rack (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Rack (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rack_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Rack (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site name (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site name (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ea67ae8ba4602f8a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "type__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ea67ae8ba4602f8a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ea67ae8ba4602f8a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ea67ae8ba4602f8a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ea67ae8ba4602f8a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ea67ae8ba4602f8a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ea67ae8ba4602f8a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ea67ae8ba4602f8a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ea67ae8ba4602f8a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ea67ae8ba4602f8a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ea67ae8ba4602f8a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ea67ae8ba4602f8a"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "virtual_chassis",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Virtual Chassis",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Virtual Chassis",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual Chassis (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_chassis_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual Chassis (ID)",
"explode": true,
"style": "form"
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedRearPortList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_rear_ports_create",
"description": "Post a list of rear port objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableRearPortRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableRearPortRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RearPort"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_rear_ports_bulk_update",
"description": "Put a list of rear port objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RearPortRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RearPortRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RearPort"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_rear_ports_bulk_partial_update",
"description": "Patch a list of rear port objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RearPortRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RearPortRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RearPort"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_rear_ports_bulk_destroy",
"description": "Delete a list of rear port objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RearPortRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RearPortRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/rear-ports/{id}/": {
"get": {
"operationId": "dcim_rear_ports_retrieve",
"description": "Get a rear port object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this rear port.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RearPort"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_rear_ports_update",
"description": "Put a rear port object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this rear port.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableRearPortRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableRearPortRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RearPort"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_rear_ports_partial_update",
"description": "Patch a rear port object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this rear port.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableRearPortRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableRearPortRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RearPort"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_rear_ports_destroy",
"description": "Delete a rear port object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this rear port.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/rear-ports/{id}/paths/": {
"get": {
"operationId": "dcim_rear_ports_paths_retrieve",
"description": "Return all CablePaths which traverse a given pass-through port.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this rear port.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RearPort"
}
}
},
"description": ""
}
}
}
},
"/api/dcim/regions/": {
"get": {
"operationId": "dcim_regions_list",
"description": "Get a list of region objects.",
"parameters": [
{
"in": "query",
"name": "ancestor",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ancestor__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ancestor_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ancestor_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "parent",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Parent region (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "parent__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Parent region (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "parent_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Parent region (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "parent_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Parent region (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "slug",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "slug__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedRegionList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_regions_create",
"description": "Post a list of region objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableRegionRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableRegionRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Region"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_regions_bulk_update",
"description": "Put a list of region objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RegionRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RegionRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Region"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_regions_bulk_partial_update",
"description": "Patch a list of region objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RegionRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RegionRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Region"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_regions_bulk_destroy",
"description": "Delete a list of region objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RegionRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RegionRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/regions/{id}/": {
"get": {
"operationId": "dcim_regions_retrieve",
"description": "Get a region object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this region.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Region"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_regions_update",
"description": "Put a region object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this region.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableRegionRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableRegionRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Region"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_regions_partial_update",
"description": "Patch a region object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this region.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableRegionRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableRegionRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Region"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_regions_destroy",
"description": "Delete a region object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this region.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/site-groups/": {
"get": {
"operationId": "dcim_site_groups_list",
"description": "Get a list of site group objects.",
"parameters": [
{
"in": "query",
"name": "ancestor",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ancestor__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ancestor_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ancestor_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "parent",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Parent site group (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "parent__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Parent site group (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "parent_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Parent site group (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "parent_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Parent site group (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "slug",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "slug__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedSiteGroupList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_site_groups_create",
"description": "Post a list of site group objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableSiteGroupRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableSiteGroupRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SiteGroup"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_site_groups_bulk_update",
"description": "Put a list of site group objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SiteGroupRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SiteGroupRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SiteGroup"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_site_groups_bulk_partial_update",
"description": "Patch a list of site group objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SiteGroupRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SiteGroupRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SiteGroup"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_site_groups_bulk_destroy",
"description": "Delete a list of site group objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SiteGroupRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SiteGroupRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/site-groups/{id}/": {
"get": {
"operationId": "dcim_site_groups_retrieve",
"description": "Get a site group object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this site group.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SiteGroup"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_site_groups_update",
"description": "Put a site group object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this site group.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableSiteGroupRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableSiteGroupRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SiteGroup"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_site_groups_partial_update",
"description": "Patch a site group object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this site group.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableSiteGroupRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableSiteGroupRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SiteGroup"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_site_groups_destroy",
"description": "Delete a site group object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this site group.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/sites/": {
"get": {
"operationId": "dcim_sites_list",
"description": "Get a list of site objects.",
"parameters": [
{
"in": "query",
"name": "asn",
"schema": {
"type": "array",
"items": {
"type": "integer",
"maximum": 4294967295,
"minimum": 1,
"format": "int64"
}
},
"description": "AS (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asn__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"maximum": 4294967295,
"minimum": 1,
"format": "int64"
}
},
"description": "AS (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asn_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "AS (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asn_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "AS (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "facility",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "facility__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "facility__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "facility__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "facility__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "facility__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "facility__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "facility__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "facility__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "facility__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "facility__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "facility__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "facility__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "latitude",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "latitude__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "latitude__gt",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "latitude__gte",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "latitude__lt",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "latitude__lte",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "latitude__n",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "longitude",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "longitude__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "longitude__gt",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "longitude__gte",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "longitude__lt",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "longitude__lte",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "longitude__n",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "region",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "slug__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e363a8ddb138be50"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "status__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e363a8ddb138be50"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e363a8ddb138be50"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e363a8ddb138be50"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e363a8ddb138be50"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e363a8ddb138be50"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e363a8ddb138be50"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e363a8ddb138be50"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e363a8ddb138be50"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e363a8ddb138be50"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e363a8ddb138be50"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "e363a8ddb138be50"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "time_zone",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "time_zone__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "time_zone__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "time_zone__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "time_zone__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "time_zone__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "time_zone__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "time_zone__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "time_zone__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "time_zone__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "time_zone__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "time_zone__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedSiteList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_sites_create",
"description": "Post a list of site objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableSiteRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableSiteRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Site"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_sites_bulk_update",
"description": "Put a list of site objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SiteRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SiteRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Site"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_sites_bulk_partial_update",
"description": "Patch a list of site objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SiteRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SiteRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Site"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_sites_bulk_destroy",
"description": "Delete a list of site objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SiteRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SiteRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/sites/{id}/": {
"get": {
"operationId": "dcim_sites_retrieve",
"description": "Get a site object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this site.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Site"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_sites_update",
"description": "Put a site object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this site.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableSiteRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableSiteRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Site"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_sites_partial_update",
"description": "Patch a site object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this site.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableSiteRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableSiteRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Site"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_sites_destroy",
"description": "Delete a site object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this site.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/virtual-chassis/": {
"get": {
"operationId": "dcim_virtual_chassis_list",
"description": "Get a list of virtual chassis objects.",
"parameters": [
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "domain",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "domain__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "domain__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "domain__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "domain__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "domain__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "domain__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "domain__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "domain__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "domain__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "domain__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "domain__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "domain__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "master",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
},
"description": "Master (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "master__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
},
"description": "Master (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "master_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Master (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "master_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Master (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "member_count",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "member_count__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "member_count__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "member_count__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "member_count__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "member_count__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "member_count__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "region",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site name (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site name (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedVirtualChassisList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_virtual_chassis_create",
"description": "Post a list of virtual chassis objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableVirtualChassisRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableVirtualChassisRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualChassis"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_virtual_chassis_bulk_update",
"description": "Put a list of virtual chassis objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualChassisRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualChassisRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualChassis"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_virtual_chassis_bulk_partial_update",
"description": "Patch a list of virtual chassis objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualChassisRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualChassisRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualChassis"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_virtual_chassis_bulk_destroy",
"description": "Delete a list of virtual chassis objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualChassisRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualChassisRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/virtual-chassis/{id}/": {
"get": {
"operationId": "dcim_virtual_chassis_retrieve",
"description": "Get a virtual chassis object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this virtual chassis.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualChassis"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_virtual_chassis_update",
"description": "Put a virtual chassis object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this virtual chassis.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableVirtualChassisRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableVirtualChassisRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualChassis"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_virtual_chassis_partial_update",
"description": "Patch a virtual chassis object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this virtual chassis.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableVirtualChassisRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableVirtualChassisRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualChassis"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_virtual_chassis_destroy",
"description": "Delete a virtual chassis object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this virtual chassis.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/virtual-device-contexts/": {
"get": {
"operationId": "dcim_virtual_device_contexts_list",
"description": "Get a list of virtual device context objects.",
"parameters": [
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device model",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device model",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "VDC (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "VDC (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "has_primary_ip",
"schema": {
"type": "boolean"
},
"description": "Has a primary IP"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "identifier",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "identifier__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "identifier__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "identifier__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "identifier__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "identifier__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "identifier__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Interface (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Interface (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "primary_ip4",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Primary IPv4 (address)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "primary_ip4__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Primary IPv4 (address)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "primary_ip4_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Primary IPv4 (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "primary_ip4_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Primary IPv4 (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "primary_ip6",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Primary IPv6 (address)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "primary_ip6__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Primary IPv6 (address)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "primary_ip6_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Primary IPv6 (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "primary_ip6_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Primary IPv6 (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "status",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ee1ef02def7a91ab"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "status__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ee1ef02def7a91ab"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ee1ef02def7a91ab"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ee1ef02def7a91ab"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ee1ef02def7a91ab"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ee1ef02def7a91ab"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ee1ef02def7a91ab"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ee1ef02def7a91ab"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ee1ef02def7a91ab"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ee1ef02def7a91ab"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ee1ef02def7a91ab"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "ee1ef02def7a91ab"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedVirtualDeviceContextList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dcim_virtual_device_contexts_create",
"description": "Post a list of virtual device context objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableVirtualDeviceContextRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableVirtualDeviceContextRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualDeviceContext"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_virtual_device_contexts_bulk_update",
"description": "Put a list of virtual device context objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualDeviceContextRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualDeviceContextRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualDeviceContext"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_virtual_device_contexts_bulk_partial_update",
"description": "Patch a list of virtual device context objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualDeviceContextRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualDeviceContextRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualDeviceContext"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_virtual_device_contexts_bulk_destroy",
"description": "Delete a list of virtual device context objects.",
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualDeviceContextRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualDeviceContextRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/dcim/virtual-device-contexts/{id}/": {
"get": {
"operationId": "dcim_virtual_device_contexts_retrieve",
"description": "Get a virtual device context object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this virtual device context.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualDeviceContext"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dcim_virtual_device_contexts_update",
"description": "Put a virtual device context object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this virtual device context.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableVirtualDeviceContextRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableVirtualDeviceContextRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualDeviceContext"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dcim_virtual_device_contexts_partial_update",
"description": "Patch a virtual device context object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this virtual device context.",
"required": true
}
],
"tags": [
"dcim"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableVirtualDeviceContextRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableVirtualDeviceContextRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualDeviceContext"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dcim_virtual_device_contexts_destroy",
"description": "Delete a virtual device context object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this virtual device context.",
"required": true
}
],
"tags": [
"dcim"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/extras/bookmarks/": {
"get": {
"operationId": "extras_bookmarks_list",
"description": "Get a list of bookmark objects.",
"parameters": [
{
"in": "query",
"name": "created",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "object_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "object_id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_type",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__n",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_type_id__empty",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_type_id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_type_id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_type_id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_type_id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "user",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "User (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "user__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "User (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "user_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "User (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "user_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "User (ID)",
"explode": true,
"style": "form"
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedBookmarkList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "extras_bookmarks_create",
"description": "Post a list of bookmark objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BookmarkRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/BookmarkRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Bookmark"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "extras_bookmarks_bulk_update",
"description": "Put a list of bookmark objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BookmarkRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BookmarkRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Bookmark"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "extras_bookmarks_bulk_partial_update",
"description": "Patch a list of bookmark objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BookmarkRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BookmarkRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Bookmark"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "extras_bookmarks_bulk_destroy",
"description": "Delete a list of bookmark objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BookmarkRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BookmarkRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/extras/bookmarks/{id}/": {
"get": {
"operationId": "extras_bookmarks_retrieve",
"description": "Get a bookmark object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this bookmark.",
"required": true
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Bookmark"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "extras_bookmarks_update",
"description": "Put a bookmark object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this bookmark.",
"required": true
}
],
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BookmarkRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/BookmarkRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Bookmark"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "extras_bookmarks_partial_update",
"description": "Patch a bookmark object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this bookmark.",
"required": true
}
],
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedBookmarkRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedBookmarkRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Bookmark"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "extras_bookmarks_destroy",
"description": "Delete a bookmark object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this bookmark.",
"required": true
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/extras/config-context-profiles/": {
"get": {
"operationId": "extras_config_context_profiles_list",
"description": "Get a list of config context profile objects.",
"parameters": [
{
"in": "query",
"name": "auto_sync_enabled",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "data_file_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Data file (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "data_file_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Data file (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "data_source_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Data source (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "data_source_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Data source (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "data_synced",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "data_synced__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "data_synced__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "data_synced__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "data_synced__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "data_synced__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "data_synced__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedConfigContextProfileList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "extras_config_context_profiles_create",
"description": "Post a list of config context profile objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigContextProfileRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ConfigContextProfileRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigContextProfile"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "extras_config_context_profiles_bulk_update",
"description": "Put a list of config context profile objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfigContextProfileRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfigContextProfileRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfigContextProfile"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "extras_config_context_profiles_bulk_partial_update",
"description": "Patch a list of config context profile objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfigContextProfileRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfigContextProfileRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfigContextProfile"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "extras_config_context_profiles_bulk_destroy",
"description": "Delete a list of config context profile objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfigContextProfileRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfigContextProfileRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/extras/config-context-profiles/{id}/": {
"get": {
"operationId": "extras_config_context_profiles_retrieve",
"description": "Get a config context profile object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this config context profile.",
"required": true
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigContextProfile"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "extras_config_context_profiles_update",
"description": "Put a config context profile object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this config context profile.",
"required": true
}
],
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigContextProfileRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ConfigContextProfileRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigContextProfile"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "extras_config_context_profiles_partial_update",
"description": "Patch a config context profile object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this config context profile.",
"required": true
}
],
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedConfigContextProfileRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedConfigContextProfileRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigContextProfile"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "extras_config_context_profiles_destroy",
"description": "Delete a config context profile object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this config context profile.",
"required": true
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/extras/config-context-profiles/{id}/sync/": {
"post": {
"operationId": "extras_config_context_profiles_sync_create",
"description": "Provide a /sync API endpoint to synchronize an object's data from its associated DataFile (if any).",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this config context profile.",
"required": true
}
],
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigContextProfileRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ConfigContextProfileRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigContextProfile"
}
}
},
"description": ""
}
}
}
},
"/api/extras/config-contexts/": {
"get": {
"operationId": "extras_config_contexts_list",
"description": "Get a list of config context objects.",
"parameters": [
{
"in": "query",
"name": "auto_sync_enabled",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "cluster_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Cluster group (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cluster_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Cluster group (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cluster_group_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Cluster group",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cluster_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Cluster group",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cluster_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Cluster",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cluster_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Cluster",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cluster_type",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Cluster type (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cluster_type__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Cluster type (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cluster_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Cluster type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cluster_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Cluster type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "data_file_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Data file (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "data_file_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Data file (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "data_source_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Data source (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "data_source_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Data source (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "data_synced",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "data_synced__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "data_synced__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "data_synced__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "data_synced__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "data_synced__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "data_synced__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_role_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device type",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "is_active",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "location",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Location (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Location (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Location",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Location",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "platform",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Platform (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "platform__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Platform (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "platform_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Platform",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "platform_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Platform",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "profile",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Profile (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "profile__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Profile (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "profile_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Profile (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "profile_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Profile (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "region",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Region (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Region (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Region",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Region",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site group (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site group (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site group",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site group",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tag (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tag (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Tag",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Tag",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant group (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant group (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Tenant group",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Tenant group",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Tenant",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Tenant",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "weight",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "weight__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedConfigContextList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "extras_config_contexts_create",
"description": "Post a list of config context objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigContextRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ConfigContextRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigContext"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "extras_config_contexts_bulk_update",
"description": "Put a list of config context objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfigContextRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfigContextRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfigContext"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "extras_config_contexts_bulk_partial_update",
"description": "Patch a list of config context objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfigContextRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfigContextRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfigContext"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "extras_config_contexts_bulk_destroy",
"description": "Delete a list of config context objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfigContextRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfigContextRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/extras/config-contexts/{id}/": {
"get": {
"operationId": "extras_config_contexts_retrieve",
"description": "Get a config context object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this config context.",
"required": true
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigContext"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "extras_config_contexts_update",
"description": "Put a config context object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this config context.",
"required": true
}
],
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigContextRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ConfigContextRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigContext"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "extras_config_contexts_partial_update",
"description": "Patch a config context object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this config context.",
"required": true
}
],
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedConfigContextRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedConfigContextRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigContext"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "extras_config_contexts_destroy",
"description": "Delete a config context object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this config context.",
"required": true
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/extras/config-contexts/{id}/sync/": {
"post": {
"operationId": "extras_config_contexts_sync_create",
"description": "Provide a /sync API endpoint to synchronize an object's data from its associated DataFile (if any).",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this config context.",
"required": true
}
],
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigContextRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ConfigContextRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigContext"
}
}
},
"description": ""
}
}
}
},
"/api/extras/config-templates/": {
"get": {
"operationId": "extras_config_templates_list",
"description": "Get a list of config template objects.",
"parameters": [
{
"in": "query",
"name": "as_attachment",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "auto_sync_enabled",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "data_file_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Data file (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "data_file_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Data file (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "data_source_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Data source (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "data_source_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Data source (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "data_synced",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "data_synced__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "data_synced__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "data_synced__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "data_synced__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "data_synced__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "data_synced__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "file_extension",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "file_extension__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "file_extension__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "file_extension__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "file_extension__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "file_extension__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "file_extension__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "file_extension__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "file_extension__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "file_extension__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "file_extension__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "file_extension__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "file_extension__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "file_name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "file_name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "file_name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "file_name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "file_name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "file_name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "file_name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "file_name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "file_name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "file_name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "file_name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "file_name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "file_name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "mime_type",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mime_type__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "mime_type__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mime_type__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mime_type__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mime_type__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mime_type__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mime_type__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mime_type__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mime_type__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mime_type__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mime_type__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mime_type__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedConfigTemplateList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "extras_config_templates_create",
"description": "Post a list of config template objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ConfigTemplateRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigTemplate"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "extras_config_templates_bulk_update",
"description": "Put a list of config template objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfigTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfigTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfigTemplate"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "extras_config_templates_bulk_partial_update",
"description": "Patch a list of config template objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfigTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfigTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfigTemplate"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "extras_config_templates_bulk_destroy",
"description": "Delete a list of config template objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfigTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfigTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/extras/config-templates/{id}/": {
"get": {
"operationId": "extras_config_templates_retrieve",
"description": "Get a config template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this config template.",
"required": true
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigTemplate"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "extras_config_templates_update",
"description": "Put a config template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this config template.",
"required": true
}
],
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ConfigTemplateRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigTemplate"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "extras_config_templates_partial_update",
"description": "Patch a config template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this config template.",
"required": true
}
],
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedConfigTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedConfigTemplateRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigTemplate"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "extras_config_templates_destroy",
"description": "Delete a config template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this config template.",
"required": true
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/extras/config-templates/{id}/render/": {
"post": {
"operationId": "extras_config_templates_render_create",
"description": "Render a ConfigTemplate using the context data provided (if any). If the client requests \"text/plain\" data,\nreturn the raw rendered content, rather than serialized JSON.",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"json",
"txt"
]
}
},
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this config template.",
"required": true
}
],
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ConfigTemplateRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigTemplate"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ConfigTemplate"
}
}
},
"description": ""
}
}
}
},
"/api/extras/config-templates/{id}/sync/": {
"post": {
"operationId": "extras_config_templates_sync_create",
"description": "Provide a /sync API endpoint to synchronize an object's data from its associated DataFile (if any).",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this config template.",
"required": true
}
],
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ConfigTemplateRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigTemplate"
}
}
},
"description": ""
}
}
}
},
"/api/extras/custom-field-choice-sets/": {
"get": {
"operationId": "extras_custom_field_choice_sets_list",
"description": "Get a list of custom field choice set objects.",
"parameters": [
{
"in": "query",
"name": "base_choices",
"schema": {
"type": "string",
"x-spec-enum-id": "cf0efb5195f85007",
"nullable": true,
"enum": [
"IATA",
"ISO_3166",
"UN_LOCODE"
]
},
"description": "Base set of predefined choices (optional)\n\n* `IATA` - IATA (Airport codes)\n* `ISO_3166` - ISO 3166 (Country codes)\n* `UN_LOCODE` - UN/LOCODE (Location codes)"
},
{
"in": "query",
"name": "choice",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "order_alphabetically",
"schema": {
"type": "boolean"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedCustomFieldChoiceSetList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "extras_custom_field_choice_sets_create",
"description": "Post a list of custom field choice set objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableCustomFieldChoiceSetRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableCustomFieldChoiceSetRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomFieldChoiceSet"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "extras_custom_field_choice_sets_bulk_update",
"description": "Put a list of custom field choice set objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFieldChoiceSetRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFieldChoiceSetRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFieldChoiceSet"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "extras_custom_field_choice_sets_bulk_partial_update",
"description": "Patch a list of custom field choice set objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFieldChoiceSetRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFieldChoiceSetRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFieldChoiceSet"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "extras_custom_field_choice_sets_bulk_destroy",
"description": "Delete a list of custom field choice set objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFieldChoiceSetRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFieldChoiceSetRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/extras/custom-field-choice-sets/{id}/": {
"get": {
"operationId": "extras_custom_field_choice_sets_retrieve",
"description": "Get a custom field choice set object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this custom field choice set.",
"required": true
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomFieldChoiceSet"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "extras_custom_field_choice_sets_update",
"description": "Put a custom field choice set object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this custom field choice set.",
"required": true
}
],
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableCustomFieldChoiceSetRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableCustomFieldChoiceSetRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomFieldChoiceSet"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "extras_custom_field_choice_sets_partial_update",
"description": "Patch a custom field choice set object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this custom field choice set.",
"required": true
}
],
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableCustomFieldChoiceSetRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableCustomFieldChoiceSetRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomFieldChoiceSet"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "extras_custom_field_choice_sets_destroy",
"description": "Delete a custom field choice set object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this custom field choice set.",
"required": true
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/extras/custom-field-choice-sets/{id}/choices/": {
"get": {
"operationId": "extras_custom_field_choice_sets_choices_retrieve",
"description": "Provides an endpoint to iterate through each choice in a set.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this custom field choice set.",
"required": true
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomFieldChoiceSet"
}
}
},
"description": ""
}
}
}
},
"/api/extras/custom-fields/": {
"get": {
"operationId": "extras_custom_fields_list",
"description": "Get a list of custom field objects.",
"parameters": [
{
"in": "query",
"name": "choice_set",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "choice_set__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "choice_set_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "choice_set_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "filter_logic",
"schema": {
"type": "string",
"x-spec-enum-id": "a958350ae21c10ee",
"enum": [
"disabled",
"exact",
"loose"
]
},
"description": "Loose matches any instance of a given string; exact matches the entire field.\n\n* `disabled` - Disabled\n* `loose` - Loose\n* `exact` - Exact"
},
{
"in": "query",
"name": "group_name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "group_name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "is_cloneable",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "label",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "label__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "label__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_type",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__ic",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__ie",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__iew",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__iregex",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__isw",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__n",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__nic",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__nie",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__niew",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__nisw",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__regex",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "related_object_type",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "related_object_type__n",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "related_object_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "related_object_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "required",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "search_weight",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "search_weight__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "search_weight__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "search_weight__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "search_weight__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "search_weight__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "search_weight__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "22e3a64138d10046"
}
},
"description": "The type of data this custom field holds",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "type__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "22e3a64138d10046"
}
},
"description": "The type of data this custom field holds",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "22e3a64138d10046"
}
},
"description": "The type of data this custom field holds",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "22e3a64138d10046"
}
},
"description": "The type of data this custom field holds",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "22e3a64138d10046"
}
},
"description": "The type of data this custom field holds",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "22e3a64138d10046"
}
},
"description": "The type of data this custom field holds",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "22e3a64138d10046"
}
},
"description": "The type of data this custom field holds",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "22e3a64138d10046"
}
},
"description": "The type of data this custom field holds",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "22e3a64138d10046"
}
},
"description": "The type of data this custom field holds",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "22e3a64138d10046"
}
},
"description": "The type of data this custom field holds",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "22e3a64138d10046"
}
},
"description": "The type of data this custom field holds",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "22e3a64138d10046"
}
},
"description": "The type of data this custom field holds",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ui_editable",
"schema": {
"type": "string",
"x-spec-enum-id": "1065673147e26bb5",
"enum": [
"hidden",
"no",
"yes"
]
},
"description": "Specifies whether the custom field value can be edited in the UI\n\n* `yes` - Yes\n* `no` - No\n* `hidden` - Hidden"
},
{
"in": "query",
"name": "ui_visible",
"schema": {
"type": "string",
"x-spec-enum-id": "cd2cf94af56de747",
"enum": [
"always",
"hidden",
"if-set"
]
},
"description": "Specifies whether the custom field is displayed in the UI\n\n* `always` - Always\n* `if-set` - If set\n* `hidden` - Hidden"
},
{
"in": "query",
"name": "unique",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "validation_maximum",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "validation_maximum__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "validation_maximum__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "validation_maximum__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "validation_maximum__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "validation_maximum__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "validation_maximum__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "validation_minimum",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "validation_minimum__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "validation_minimum__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "validation_minimum__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "validation_minimum__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "validation_minimum__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "validation_minimum__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "validation_regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "validation_regex__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "validation_regex__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "validation_regex__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "validation_regex__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "validation_regex__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "validation_regex__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "validation_regex__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "validation_regex__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "validation_regex__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "validation_regex__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "validation_regex__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "validation_regex__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "weight__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedCustomFieldList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "extras_custom_fields_create",
"description": "Post a list of custom field objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableCustomFieldRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableCustomFieldRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomField"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "extras_custom_fields_bulk_update",
"description": "Put a list of custom field objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFieldRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFieldRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomField"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "extras_custom_fields_bulk_partial_update",
"description": "Patch a list of custom field objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFieldRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFieldRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomField"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "extras_custom_fields_bulk_destroy",
"description": "Delete a list of custom field objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFieldRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFieldRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/extras/custom-fields/{id}/": {
"get": {
"operationId": "extras_custom_fields_retrieve",
"description": "Get a custom field object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this custom field.",
"required": true
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomField"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "extras_custom_fields_update",
"description": "Put a custom field object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this custom field.",
"required": true
}
],
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableCustomFieldRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableCustomFieldRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomField"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "extras_custom_fields_partial_update",
"description": "Patch a custom field object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this custom field.",
"required": true
}
],
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableCustomFieldRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableCustomFieldRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomField"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "extras_custom_fields_destroy",
"description": "Delete a custom field object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this custom field.",
"required": true
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/extras/custom-links/": {
"get": {
"operationId": "extras_custom_links_list",
"description": "Get a list of custom link objects.",
"parameters": [
{
"in": "query",
"name": "button_class",
"schema": {
"type": "string",
"x-spec-enum-id": "ee8e5bb1ccdcdb19",
"enum": [
"black",
"blue",
"cyan",
"default",
"ghost-dark",
"gray",
"green",
"indigo",
"orange",
"pink",
"purple",
"red",
"teal",
"white",
"yellow"
]
},
"description": "The class of the first link in a group will be used for the dropdown button\n\n* `default` - Default\n* `blue` - Blue\n* `indigo` - Indigo\n* `purple` - Purple\n* `pink` - Pink\n* `red` - Red\n* `orange` - Orange\n* `yellow` - Yellow\n* `green` - Green\n* `teal` - Teal\n* `cyan` - Cyan\n* `gray` - Gray\n* `black` - Black\n* `white` - White\n* `ghost-dark` - Link"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "enabled",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "group_name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "group_name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "link_text",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "link_text__ic",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "link_text__ie",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "link_text__iew",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "link_text__iregex",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "link_text__isw",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "link_text__n",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "link_text__nic",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "link_text__nie",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "link_text__niew",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "link_text__nisw",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "link_text__regex",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "link_url",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "link_url__ic",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "link_url__ie",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "link_url__iew",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "link_url__iregex",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "link_url__isw",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "link_url__n",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "link_url__nic",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "link_url__nie",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "link_url__niew",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "link_url__nisw",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "link_url__regex",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "new_window",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "object_type",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__ic",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__ie",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__iew",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__iregex",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__isw",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__n",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__nic",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__nie",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__niew",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__nisw",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__regex",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "weight",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "weight__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedCustomLinkList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "extras_custom_links_create",
"description": "Post a list of custom link objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomLinkRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/CustomLinkRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomLink"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "extras_custom_links_bulk_update",
"description": "Put a list of custom link objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomLinkRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomLinkRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomLink"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "extras_custom_links_bulk_partial_update",
"description": "Patch a list of custom link objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomLinkRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomLinkRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomLink"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "extras_custom_links_bulk_destroy",
"description": "Delete a list of custom link objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomLinkRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomLinkRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/extras/custom-links/{id}/": {
"get": {
"operationId": "extras_custom_links_retrieve",
"description": "Get a custom link object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this custom link.",
"required": true
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomLink"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "extras_custom_links_update",
"description": "Put a custom link object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this custom link.",
"required": true
}
],
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomLinkRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/CustomLinkRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomLink"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "extras_custom_links_partial_update",
"description": "Patch a custom link object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this custom link.",
"required": true
}
],
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedCustomLinkRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedCustomLinkRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomLink"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "extras_custom_links_destroy",
"description": "Delete a custom link object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this custom link.",
"required": true
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/extras/dashboard/": {
"get": {
"operationId": "extras_dashboard_retrieve",
"description": "Get a list of dashboard objects.",
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Dashboard"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "extras_dashboard_update",
"description": "Put a list of dashboard objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DashboardRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/DashboardRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Dashboard"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "extras_dashboard_partial_update",
"description": "Patch a list of dashboard objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedDashboardRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedDashboardRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Dashboard"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "extras_dashboard_destroy",
"description": "Delete a list of dashboard objects.",
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/extras/event-rules/": {
"get": {
"operationId": "extras_event_rules_list",
"description": "Get a list of event rule objects.",
"parameters": [
{
"in": "query",
"name": "action_object_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "action_object_id__empty",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "action_object_id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "action_object_id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "action_object_id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "action_object_id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "action_object_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "action_object_type",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "action_object_type__n",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "action_type",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d07193c73ebc03c6"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "action_type__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "action_type__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d07193c73ebc03c6"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "action_type__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d07193c73ebc03c6"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "action_type__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d07193c73ebc03c6"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "action_type__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d07193c73ebc03c6"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "action_type__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d07193c73ebc03c6"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "action_type__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d07193c73ebc03c6"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "action_type__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d07193c73ebc03c6"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "action_type__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d07193c73ebc03c6"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "action_type__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d07193c73ebc03c6"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "action_type__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d07193c73ebc03c6"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "action_type__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d07193c73ebc03c6"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "enabled",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "event_type",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_type",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__ic",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__ie",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__iew",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__iregex",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__isw",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__n",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__nic",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__nie",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__niew",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__nisw",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__regex",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedEventRuleList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "extras_event_rules_create",
"description": "Post a list of event rule objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableEventRuleRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableEventRuleRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventRule"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "extras_event_rules_bulk_update",
"description": "Put a list of event rule objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventRuleRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventRuleRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventRule"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "extras_event_rules_bulk_partial_update",
"description": "Patch a list of event rule objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventRuleRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventRuleRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventRule"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "extras_event_rules_bulk_destroy",
"description": "Delete a list of event rule objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventRuleRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventRuleRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/extras/event-rules/{id}/": {
"get": {
"operationId": "extras_event_rules_retrieve",
"description": "Get a event rule object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this event rule.",
"required": true
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventRule"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "extras_event_rules_update",
"description": "Put a event rule object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this event rule.",
"required": true
}
],
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableEventRuleRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableEventRuleRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventRule"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "extras_event_rules_partial_update",
"description": "Patch a event rule object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this event rule.",
"required": true
}
],
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableEventRuleRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableEventRuleRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventRule"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "extras_event_rules_destroy",
"description": "Delete a event rule object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this event rule.",
"required": true
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/extras/export-templates/": {
"get": {
"operationId": "extras_export_templates_list",
"description": "Get a list of export template objects.",
"parameters": [
{
"in": "query",
"name": "as_attachment",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "auto_sync_enabled",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "data_file_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Data file (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "data_file_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Data file (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "data_source_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Data source (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "data_source_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Data source (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "data_synced",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "data_synced__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "data_synced__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "data_synced__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "data_synced__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "data_synced__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "data_synced__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "file_extension",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "file_extension__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "file_extension__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "file_extension__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "file_extension__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "file_extension__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "file_extension__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "file_extension__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "file_extension__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "file_extension__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "file_extension__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "file_extension__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "file_extension__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "file_name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "file_name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "file_name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "file_name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "file_name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "file_name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "file_name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "file_name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "file_name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "file_name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "file_name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "file_name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "file_name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "mime_type",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mime_type__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "mime_type__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mime_type__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mime_type__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mime_type__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mime_type__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mime_type__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mime_type__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mime_type__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mime_type__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mime_type__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mime_type__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_type",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__ic",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__ie",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__iew",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__iregex",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__isw",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__n",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__nic",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__nie",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__niew",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__nisw",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__regex",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedExportTemplateList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "extras_export_templates_create",
"description": "Post a list of export template objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ExportTemplateRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportTemplate"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "extras_export_templates_bulk_update",
"description": "Put a list of export template objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExportTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExportTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExportTemplate"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "extras_export_templates_bulk_partial_update",
"description": "Patch a list of export template objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExportTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExportTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExportTemplate"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "extras_export_templates_bulk_destroy",
"description": "Delete a list of export template objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExportTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExportTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/extras/export-templates/{id}/": {
"get": {
"operationId": "extras_export_templates_retrieve",
"description": "Get a export template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this export template.",
"required": true
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportTemplate"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "extras_export_templates_update",
"description": "Put a export template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this export template.",
"required": true
}
],
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ExportTemplateRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportTemplate"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "extras_export_templates_partial_update",
"description": "Patch a export template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this export template.",
"required": true
}
],
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedExportTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedExportTemplateRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportTemplate"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "extras_export_templates_destroy",
"description": "Delete a export template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this export template.",
"required": true
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/extras/export-templates/{id}/sync/": {
"post": {
"operationId": "extras_export_templates_sync_create",
"description": "Provide a /sync API endpoint to synchronize an object's data from its associated DataFile (if any).",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this export template.",
"required": true
}
],
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ExportTemplateRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportTemplate"
}
}
},
"description": ""
}
}
}
},
"/api/extras/image-attachments/": {
"get": {
"operationId": "extras_image_attachments_list",
"description": "Get a list of image attachment objects.",
"parameters": [
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "image_height",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "image_height__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "image_height__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "image_height__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "image_height__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "image_height__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "image_height__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "image_width",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "image_width__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "image_width__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "image_width__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "image_width__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "image_width__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "image_width__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "object_id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_type",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__n",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type_id",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "object_type_id__n",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedImageAttachmentList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "extras_image_attachments_create",
"description": "Post a list of image attachment objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImageAttachmentRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ImageAttachmentRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImageAttachment"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "extras_image_attachments_bulk_update",
"description": "Put a list of image attachment objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImageAttachmentRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImageAttachmentRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImageAttachment"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "extras_image_attachments_bulk_partial_update",
"description": "Patch a list of image attachment objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImageAttachmentRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImageAttachmentRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImageAttachment"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "extras_image_attachments_bulk_destroy",
"description": "Delete a list of image attachment objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImageAttachmentRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImageAttachmentRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/extras/image-attachments/{id}/": {
"get": {
"operationId": "extras_image_attachments_retrieve",
"description": "Get a image attachment object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this image attachment.",
"required": true
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImageAttachment"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "extras_image_attachments_update",
"description": "Put a image attachment object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this image attachment.",
"required": true
}
],
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImageAttachmentRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ImageAttachmentRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImageAttachment"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "extras_image_attachments_partial_update",
"description": "Patch a image attachment object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this image attachment.",
"required": true
}
],
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedImageAttachmentRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedImageAttachmentRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImageAttachment"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "extras_image_attachments_destroy",
"description": "Delete a image attachment object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this image attachment.",
"required": true
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/extras/journal-entries/": {
"get": {
"operationId": "extras_journal_entries_list",
"description": "Get a list of journal entry objects.",
"parameters": [
{
"in": "query",
"name": "assigned_object_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "assigned_object_id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "assigned_object_id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "assigned_object_id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "assigned_object_id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "assigned_object_id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "assigned_object_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "assigned_object_type",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "assigned_object_type__n",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "assigned_object_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "assigned_object_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_after",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"in": "query",
"name": "created_before",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"in": "query",
"name": "created_by",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "User (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "User (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "User (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "User (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "kind",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a21af280f632fa34"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "kind__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "kind__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a21af280f632fa34"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "kind__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a21af280f632fa34"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "kind__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a21af280f632fa34"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "kind__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a21af280f632fa34"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "kind__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a21af280f632fa34"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "kind__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a21af280f632fa34"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "kind__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a21af280f632fa34"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "kind__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a21af280f632fa34"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "kind__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a21af280f632fa34"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "kind__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a21af280f632fa34"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "kind__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a21af280f632fa34"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedJournalEntryList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "extras_journal_entries_create",
"description": "Post a list of journal entry objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableJournalEntryRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableJournalEntryRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JournalEntry"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "extras_journal_entries_bulk_update",
"description": "Put a list of journal entry objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JournalEntryRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JournalEntryRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JournalEntry"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "extras_journal_entries_bulk_partial_update",
"description": "Patch a list of journal entry objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JournalEntryRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JournalEntryRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JournalEntry"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "extras_journal_entries_bulk_destroy",
"description": "Delete a list of journal entry objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JournalEntryRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JournalEntryRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/extras/journal-entries/{id}/": {
"get": {
"operationId": "extras_journal_entries_retrieve",
"description": "Get a journal entry object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this journal entry.",
"required": true
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JournalEntry"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "extras_journal_entries_update",
"description": "Put a journal entry object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this journal entry.",
"required": true
}
],
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableJournalEntryRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableJournalEntryRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JournalEntry"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "extras_journal_entries_partial_update",
"description": "Patch a journal entry object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this journal entry.",
"required": true
}
],
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableJournalEntryRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableJournalEntryRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JournalEntry"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "extras_journal_entries_destroy",
"description": "Delete a journal entry object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this journal entry.",
"required": true
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/extras/notification-groups/": {
"get": {
"operationId": "extras_notification_groups_list",
"description": "Get a list of notification group objects.",
"parameters": [
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedNotificationGroupList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "extras_notification_groups_create",
"description": "Post a list of notification group objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotificationGroupRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/NotificationGroupRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotificationGroup"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "extras_notification_groups_bulk_update",
"description": "Put a list of notification group objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotificationGroupRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotificationGroupRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotificationGroup"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "extras_notification_groups_bulk_partial_update",
"description": "Patch a list of notification group objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotificationGroupRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotificationGroupRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotificationGroup"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "extras_notification_groups_bulk_destroy",
"description": "Delete a list of notification group objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotificationGroupRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotificationGroupRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/extras/notification-groups/{id}/": {
"get": {
"operationId": "extras_notification_groups_retrieve",
"description": "Get a notification group object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this notification group.",
"required": true
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotificationGroup"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "extras_notification_groups_update",
"description": "Put a notification group object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this notification group.",
"required": true
}
],
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotificationGroupRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/NotificationGroupRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotificationGroup"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "extras_notification_groups_partial_update",
"description": "Patch a notification group object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this notification group.",
"required": true
}
],
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedNotificationGroupRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedNotificationGroupRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotificationGroup"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "extras_notification_groups_destroy",
"description": "Delete a notification group object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this notification group.",
"required": true
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/extras/notifications/": {
"get": {
"operationId": "extras_notifications_list",
"description": "Get a list of notification objects.",
"parameters": [
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedNotificationList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "extras_notifications_create",
"description": "Post a list of notification objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotificationRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/NotificationRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Notification"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "extras_notifications_bulk_update",
"description": "Put a list of notification objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotificationRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotificationRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Notification"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "extras_notifications_bulk_partial_update",
"description": "Patch a list of notification objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotificationRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotificationRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Notification"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "extras_notifications_bulk_destroy",
"description": "Delete a list of notification objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotificationRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotificationRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/extras/notifications/{id}/": {
"get": {
"operationId": "extras_notifications_retrieve",
"description": "Get a notification object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this notification.",
"required": true
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Notification"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "extras_notifications_update",
"description": "Put a notification object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this notification.",
"required": true
}
],
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotificationRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/NotificationRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Notification"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "extras_notifications_partial_update",
"description": "Patch a notification object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this notification.",
"required": true
}
],
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedNotificationRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedNotificationRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Notification"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "extras_notifications_destroy",
"description": "Delete a notification object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this notification.",
"required": true
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/extras/object-types/": {
"get": {
"operationId": "extras_object_types_list",
"description": "Read-only list of ObjectTypes.",
"parameters": [
{
"in": "query",
"name": "app_label",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "app_label__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "app_label__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "app_label__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "app_label__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "app_label__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "app_label__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "app_label__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "app_label__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "app_label__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "app_label__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "app_label__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "app_label__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "features",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "model",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "model__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "model__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "public",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedObjectTypeList"
}
}
},
"description": ""
}
}
}
},
"/api/extras/object-types/{id}/": {
"get": {
"operationId": "extras_object_types_retrieve",
"description": "Read-only list of ObjectTypes.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this object type.",
"required": true
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectType"
}
}
},
"description": ""
}
}
}
},
"/api/extras/saved-filters/": {
"get": {
"operationId": "extras_saved_filters_list",
"description": "Get a list of saved filter objects.",
"parameters": [
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "enabled",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_type",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__ic",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__ie",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__iew",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__iregex",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__isw",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__n",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__nic",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__nie",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__niew",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__nisw",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__regex",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "shared",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "slug",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "slug__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "usable",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "user",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "User (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "user__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "User (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "user_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "User (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "user_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "User (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "weight__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedSavedFilterList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "extras_saved_filters_create",
"description": "Post a list of saved filter objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SavedFilterRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/SavedFilterRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SavedFilter"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "extras_saved_filters_bulk_update",
"description": "Put a list of saved filter objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SavedFilterRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SavedFilterRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SavedFilter"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "extras_saved_filters_bulk_partial_update",
"description": "Patch a list of saved filter objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SavedFilterRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SavedFilterRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SavedFilter"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "extras_saved_filters_bulk_destroy",
"description": "Delete a list of saved filter objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SavedFilterRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SavedFilterRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/extras/saved-filters/{id}/": {
"get": {
"operationId": "extras_saved_filters_retrieve",
"description": "Get a saved filter object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this saved filter.",
"required": true
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SavedFilter"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "extras_saved_filters_update",
"description": "Put a saved filter object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this saved filter.",
"required": true
}
],
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SavedFilterRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/SavedFilterRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SavedFilter"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "extras_saved_filters_partial_update",
"description": "Patch a saved filter object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this saved filter.",
"required": true
}
],
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedSavedFilterRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedSavedFilterRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SavedFilter"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "extras_saved_filters_destroy",
"description": "Delete a saved filter object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this saved filter.",
"required": true
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/extras/scripts/": {
"get": {
"operationId": "extras_scripts_list",
"description": "Get a list of script objects.",
"parameters": [
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "is_executable",
"schema": {
"type": "boolean"
}
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "module_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Script module (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "module_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Script module (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedScriptList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "extras_scripts_create",
"description": "Post a list of script objects.",
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Script"
}
}
},
"description": ""
}
}
}
},
"/api/extras/scripts/{id}/": {
"get": {
"operationId": "extras_scripts_retrieve",
"description": "Get a script object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"pattern": "^[^/]+$"
},
"required": true
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Script"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "extras_scripts_update",
"description": "Put a script object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"pattern": "^[^/]+$"
},
"required": true
}
],
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScriptInputRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ScriptInputRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Script"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "extras_scripts_partial_update",
"description": "Patch a script object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"pattern": "^[^/]+$"
},
"required": true
}
],
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedScriptInputRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedScriptInputRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Script"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "extras_scripts_destroy",
"description": "Delete a script object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"pattern": "^[^/]+$"
},
"required": true
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/extras/subscriptions/": {
"get": {
"operationId": "extras_subscriptions_list",
"description": "Get a list of subscription objects.",
"parameters": [
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedSubscriptionList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "extras_subscriptions_create",
"description": "Post a list of subscription objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/SubscriptionRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Subscription"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "extras_subscriptions_bulk_update",
"description": "Put a list of subscription objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubscriptionRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubscriptionRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Subscription"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "extras_subscriptions_bulk_partial_update",
"description": "Patch a list of subscription objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubscriptionRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubscriptionRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Subscription"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "extras_subscriptions_bulk_destroy",
"description": "Delete a list of subscription objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubscriptionRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubscriptionRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/extras/subscriptions/{id}/": {
"get": {
"operationId": "extras_subscriptions_retrieve",
"description": "Get a subscription object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this subscription.",
"required": true
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Subscription"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "extras_subscriptions_update",
"description": "Put a subscription object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this subscription.",
"required": true
}
],
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/SubscriptionRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Subscription"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "extras_subscriptions_partial_update",
"description": "Patch a subscription object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this subscription.",
"required": true
}
],
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedSubscriptionRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedSubscriptionRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Subscription"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "extras_subscriptions_destroy",
"description": "Delete a subscription object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this subscription.",
"required": true
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/extras/table-configs/": {
"get": {
"operationId": "extras_table_configs_list",
"description": "Get a list of table config objects.",
"parameters": [
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "enabled",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_type",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__n",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "shared",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "table",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "table__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "table__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "table__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "table__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "table__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "table__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "table__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "table__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "table__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "table__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "table__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "table__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "usable",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "user",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "User (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "user__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "User (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "user_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "User (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "user_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "User (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "weight__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedTableConfigList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "extras_table_configs_create",
"description": "Post a list of table config objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TableConfigRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/TableConfigRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TableConfig"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "extras_table_configs_bulk_update",
"description": "Put a list of table config objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TableConfigRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TableConfigRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TableConfig"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "extras_table_configs_bulk_partial_update",
"description": "Patch a list of table config objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TableConfigRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TableConfigRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TableConfig"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "extras_table_configs_bulk_destroy",
"description": "Delete a list of table config objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TableConfigRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TableConfigRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/extras/table-configs/{id}/": {
"get": {
"operationId": "extras_table_configs_retrieve",
"description": "Get a table config object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this table config.",
"required": true
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TableConfig"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "extras_table_configs_update",
"description": "Put a table config object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this table config.",
"required": true
}
],
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TableConfigRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/TableConfigRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TableConfig"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "extras_table_configs_partial_update",
"description": "Patch a table config object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this table config.",
"required": true
}
],
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedTableConfigRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedTableConfigRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TableConfig"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "extras_table_configs_destroy",
"description": "Delete a table config object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this table config.",
"required": true
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/extras/tagged-objects/": {
"get": {
"operationId": "extras_tagged_objects_list",
"description": "Get a list of tagged item objects.",
"parameters": [
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "object_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "object_id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_type",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__n",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedTaggedItemList"
}
}
},
"description": ""
}
}
}
},
"/api/extras/tagged-objects/{id}/": {
"get": {
"operationId": "extras_tagged_objects_retrieve",
"description": "Get a tagged item object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this tagged item.",
"required": true
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaggedItem"
}
}
},
"description": ""
}
}
}
},
"/api/extras/tags/": {
"get": {
"operationId": "extras_tags_list",
"description": "Get a list of tag objects.",
"parameters": [
{
"in": "query",
"name": "color",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "color__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "color__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "content_type",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "content_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "for_object_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_types",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_types__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "slug",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "slug__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "weight",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "weight__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedTagList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "extras_tags_create",
"description": "Post a list of tag objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/TagRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tag"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "extras_tags_bulk_update",
"description": "Put a list of tag objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Tag"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "extras_tags_bulk_partial_update",
"description": "Patch a list of tag objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Tag"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "extras_tags_bulk_destroy",
"description": "Delete a list of tag objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/extras/tags/{id}/": {
"get": {
"operationId": "extras_tags_retrieve",
"description": "Get a tag object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this tag.",
"required": true
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tag"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "extras_tags_update",
"description": "Put a tag object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this tag.",
"required": true
}
],
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/TagRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tag"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "extras_tags_partial_update",
"description": "Patch a tag object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this tag.",
"required": true
}
],
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedTagRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedTagRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tag"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "extras_tags_destroy",
"description": "Delete a tag object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this tag.",
"required": true
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/extras/webhooks/": {
"get": {
"operationId": "extras_webhooks_list",
"description": "Get a list of webhook objects.",
"parameters": [
{
"in": "query",
"name": "ca_file_path",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ca_file_path__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "ca_file_path__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ca_file_path__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ca_file_path__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ca_file_path__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ca_file_path__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ca_file_path__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ca_file_path__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ca_file_path__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ca_file_path__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ca_file_path__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ca_file_path__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "http_content_type",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "http_content_type__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "http_content_type__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "http_content_type__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "http_content_type__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "http_content_type__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "http_content_type__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "http_content_type__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "http_content_type__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "http_content_type__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "http_content_type__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "http_content_type__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "http_content_type__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "http_method",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a12018571a034921"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "http_method__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "http_method__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a12018571a034921"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "http_method__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a12018571a034921"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "http_method__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a12018571a034921"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "http_method__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a12018571a034921"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "http_method__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a12018571a034921"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "http_method__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a12018571a034921"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "http_method__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a12018571a034921"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "http_method__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a12018571a034921"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "http_method__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a12018571a034921"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "http_method__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a12018571a034921"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "http_method__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a12018571a034921"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "payload_url",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "secret",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "secret__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "secret__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "secret__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "secret__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "secret__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "secret__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "secret__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "secret__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "secret__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "secret__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "secret__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "secret__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ssl_verification",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedWebhookList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "extras_webhooks_create",
"description": "Post a list of webhook objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WebhookRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Webhook"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "extras_webhooks_bulk_update",
"description": "Put a list of webhook objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebhookRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebhookRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Webhook"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "extras_webhooks_bulk_partial_update",
"description": "Patch a list of webhook objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebhookRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebhookRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Webhook"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "extras_webhooks_bulk_destroy",
"description": "Delete a list of webhook objects.",
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebhookRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebhookRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/extras/webhooks/{id}/": {
"get": {
"operationId": "extras_webhooks_retrieve",
"description": "Get a webhook object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this webhook.",
"required": true
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Webhook"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "extras_webhooks_update",
"description": "Put a webhook object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this webhook.",
"required": true
}
],
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WebhookRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Webhook"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "extras_webhooks_partial_update",
"description": "Patch a webhook object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this webhook.",
"required": true
}
],
"tags": [
"extras"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWebhookRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWebhookRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Webhook"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "extras_webhooks_destroy",
"description": "Delete a webhook object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this webhook.",
"required": true
}
],
"tags": [
"extras"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/ipam/aggregates/": {
"get": {
"operationId": "ipam_aggregates_list",
"description": "Get a list of aggregate objects.",
"parameters": [
{
"in": "query",
"name": "contact",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "date_added",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "date_added__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "date_added__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "date_added__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "date_added__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "date_added__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "date_added__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "family",
"schema": {
"type": "number"
}
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "prefix",
"schema": {
"type": "string"
},
"description": "Prefix"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "rir",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "RIR (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rir__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "RIR (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rir_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "RIR (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rir_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "RIR (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedAggregateList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "ipam_aggregates_create",
"description": "Post a list of aggregate objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableAggregateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableAggregateRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Aggregate"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "ipam_aggregates_bulk_update",
"description": "Put a list of aggregate objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AggregateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AggregateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Aggregate"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "ipam_aggregates_bulk_partial_update",
"description": "Patch a list of aggregate objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AggregateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AggregateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Aggregate"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "ipam_aggregates_bulk_destroy",
"description": "Delete a list of aggregate objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AggregateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AggregateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/ipam/aggregates/{id}/": {
"get": {
"operationId": "ipam_aggregates_retrieve",
"description": "Get a aggregate object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this aggregate.",
"required": true
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Aggregate"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "ipam_aggregates_update",
"description": "Put a aggregate object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this aggregate.",
"required": true
}
],
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableAggregateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableAggregateRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Aggregate"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "ipam_aggregates_partial_update",
"description": "Patch a aggregate object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this aggregate.",
"required": true
}
],
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableAggregateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableAggregateRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Aggregate"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "ipam_aggregates_destroy",
"description": "Delete a aggregate object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this aggregate.",
"required": true
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/ipam/asn-ranges/": {
"get": {
"operationId": "ipam_asn_ranges_list",
"description": "Get a list of ASN range objects.",
"parameters": [
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "end",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "end__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "end__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "end__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "end__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "end__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "end__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "rir",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "RIR (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rir__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "RIR (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rir_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "RIR (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rir_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "RIR (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "slug__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "start",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "start__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "start__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "start__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "start__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "start__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "start__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedASNRangeList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "ipam_asn_ranges_create",
"description": "Post a list of ASN range objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ASNRangeRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ASNRangeRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ASNRange"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "ipam_asn_ranges_bulk_update",
"description": "Put a list of ASN range objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ASNRangeRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ASNRangeRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ASNRange"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "ipam_asn_ranges_bulk_partial_update",
"description": "Patch a list of ASN range objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ASNRangeRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ASNRangeRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ASNRange"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "ipam_asn_ranges_bulk_destroy",
"description": "Delete a list of ASN range objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ASNRangeRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ASNRangeRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/ipam/asn-ranges/{id}/": {
"get": {
"operationId": "ipam_asn_ranges_retrieve",
"description": "Get a ASN range object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this ASN range.",
"required": true
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ASNRange"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "ipam_asn_ranges_update",
"description": "Put a ASN range object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this ASN range.",
"required": true
}
],
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ASNRangeRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ASNRangeRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ASNRange"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "ipam_asn_ranges_partial_update",
"description": "Patch a ASN range object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this ASN range.",
"required": true
}
],
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedASNRangeRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedASNRangeRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ASNRange"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "ipam_asn_ranges_destroy",
"description": "Delete a ASN range object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this ASN range.",
"required": true
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/ipam/asn-ranges/{id}/available-asns/": {
"get": {
"operationId": "ipam_asn_ranges_available_asns_list",
"description": "Get a ASN object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"required": true
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AvailableASN"
}
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "ipam_asn_ranges_available_asns_create",
"description": "Post a ASN object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"required": true
}
],
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ASNRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ASNRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ASN"
}
}
}
},
"description": ""
}
}
}
},
"/api/ipam/asns/": {
"get": {
"operationId": "ipam_asns_list",
"description": "Get a list of ASN objects.",
"parameters": [
{
"in": "query",
"name": "asn",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asn__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "asn__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asn__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asn__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asn__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "asn__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "provider",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Provider (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Provider (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Provider (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "provider_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Provider (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "rir",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "RIR (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rir__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "RIR (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rir_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "RIR (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rir_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "RIR (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedASNList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "ipam_asns_create",
"description": "Post a list of ASN objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ASNRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ASNRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ASN"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "ipam_asns_bulk_update",
"description": "Put a list of ASN objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ASNRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ASNRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ASN"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "ipam_asns_bulk_partial_update",
"description": "Patch a list of ASN objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ASNRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ASNRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ASN"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "ipam_asns_bulk_destroy",
"description": "Delete a list of ASN objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ASNRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ASNRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/ipam/asns/{id}/": {
"get": {
"operationId": "ipam_asns_retrieve",
"description": "Get a ASN object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this ASN.",
"required": true
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ASN"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "ipam_asns_update",
"description": "Put a ASN object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this ASN.",
"required": true
}
],
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ASNRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ASNRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ASN"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "ipam_asns_partial_update",
"description": "Patch a ASN object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this ASN.",
"required": true
}
],
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedASNRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedASNRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ASN"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "ipam_asns_destroy",
"description": "Delete a ASN object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this ASN.",
"required": true
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/ipam/fhrp-group-assignments/": {
"get": {
"operationId": "ipam_fhrp_group_assignments_list",
"description": "Get a list of FHRP group assignment objects.",
"parameters": [
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "device",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Group (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Group (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface_id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "interface_id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface_id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface_id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface_id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface_type",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "interface_type__n",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "priority",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "priority__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "priority__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "priority__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "priority__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "priority__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "priority__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "virtual_machine",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_machine_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedFHRPGroupAssignmentList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "ipam_fhrp_group_assignments_create",
"description": "Post a list of FHRP group assignment objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FHRPGroupAssignmentRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/FHRPGroupAssignmentRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FHRPGroupAssignment"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "ipam_fhrp_group_assignments_bulk_update",
"description": "Put a list of FHRP group assignment objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FHRPGroupAssignmentRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FHRPGroupAssignmentRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FHRPGroupAssignment"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "ipam_fhrp_group_assignments_bulk_partial_update",
"description": "Patch a list of FHRP group assignment objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FHRPGroupAssignmentRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FHRPGroupAssignmentRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FHRPGroupAssignment"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "ipam_fhrp_group_assignments_bulk_destroy",
"description": "Delete a list of FHRP group assignment objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FHRPGroupAssignmentRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FHRPGroupAssignmentRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/ipam/fhrp-group-assignments/{id}/": {
"get": {
"operationId": "ipam_fhrp_group_assignments_retrieve",
"description": "Get a FHRP group assignment object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this FHRP group assignment.",
"required": true
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FHRPGroupAssignment"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "ipam_fhrp_group_assignments_update",
"description": "Put a FHRP group assignment object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this FHRP group assignment.",
"required": true
}
],
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FHRPGroupAssignmentRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/FHRPGroupAssignmentRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FHRPGroupAssignment"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "ipam_fhrp_group_assignments_partial_update",
"description": "Patch a FHRP group assignment object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this FHRP group assignment.",
"required": true
}
],
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedFHRPGroupAssignmentRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedFHRPGroupAssignmentRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FHRPGroupAssignment"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "ipam_fhrp_group_assignments_destroy",
"description": "Delete a FHRP group assignment object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this FHRP group assignment.",
"required": true
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/ipam/fhrp-groups/": {
"get": {
"operationId": "ipam_fhrp_groups_list",
"description": "Get a list of FHRP group objects.",
"parameters": [
{
"in": "query",
"name": "auth_key",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_key__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "auth_key__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_key__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_key__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_key__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_key__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_key__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_key__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_key__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_key__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_key__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_key__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_type",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "12b9faea3a45bf37",
"nullable": true,
"title": "Authentication type"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_type__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "auth_type__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "12b9faea3a45bf37",
"nullable": true,
"title": "Authentication type"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_type__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "12b9faea3a45bf37",
"nullable": true,
"title": "Authentication type"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_type__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "12b9faea3a45bf37",
"nullable": true,
"title": "Authentication type"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_type__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "12b9faea3a45bf37",
"nullable": true,
"title": "Authentication type"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_type__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "12b9faea3a45bf37",
"nullable": true,
"title": "Authentication type"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_type__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "12b9faea3a45bf37",
"nullable": true,
"title": "Authentication type"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_type__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "12b9faea3a45bf37",
"nullable": true,
"title": "Authentication type"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_type__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "12b9faea3a45bf37",
"nullable": true,
"title": "Authentication type"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_type__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "12b9faea3a45bf37",
"nullable": true,
"title": "Authentication type"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_type__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "12b9faea3a45bf37",
"nullable": true,
"title": "Authentication type"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_type__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "12b9faea3a45bf37",
"nullable": true,
"title": "Authentication type"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "group_id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "protocol",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "40dc831c689b4b78"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "protocol__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "protocol__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "40dc831c689b4b78"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "protocol__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "40dc831c689b4b78"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "protocol__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "40dc831c689b4b78"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "protocol__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "40dc831c689b4b78"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "protocol__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "40dc831c689b4b78"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "protocol__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "40dc831c689b4b78"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "protocol__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "40dc831c689b4b78"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "protocol__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "40dc831c689b4b78"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "protocol__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "40dc831c689b4b78"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "protocol__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "40dc831c689b4b78"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "protocol__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "40dc831c689b4b78"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "related_ip",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedFHRPGroupList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "ipam_fhrp_groups_create",
"description": "Post a list of FHRP group objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FHRPGroupRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/FHRPGroupRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FHRPGroup"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "ipam_fhrp_groups_bulk_update",
"description": "Put a list of FHRP group objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FHRPGroupRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FHRPGroupRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FHRPGroup"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "ipam_fhrp_groups_bulk_partial_update",
"description": "Patch a list of FHRP group objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FHRPGroupRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FHRPGroupRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FHRPGroup"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "ipam_fhrp_groups_bulk_destroy",
"description": "Delete a list of FHRP group objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FHRPGroupRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FHRPGroupRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/ipam/fhrp-groups/{id}/": {
"get": {
"operationId": "ipam_fhrp_groups_retrieve",
"description": "Get a FHRP group object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this FHRP group.",
"required": true
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FHRPGroup"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "ipam_fhrp_groups_update",
"description": "Put a FHRP group object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this FHRP group.",
"required": true
}
],
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FHRPGroupRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/FHRPGroupRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FHRPGroup"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "ipam_fhrp_groups_partial_update",
"description": "Patch a FHRP group object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this FHRP group.",
"required": true
}
],
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedFHRPGroupRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedFHRPGroupRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FHRPGroup"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "ipam_fhrp_groups_destroy",
"description": "Delete a FHRP group object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this FHRP group.",
"required": true
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/ipam/ip-addresses/": {
"get": {
"operationId": "ipam_ip_addresses_list",
"description": "Get a list of IP address objects.",
"parameters": [
{
"in": "query",
"name": "address",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "assigned",
"schema": {
"type": "boolean"
},
"description": "Is assigned"
},
{
"in": "query",
"name": "assigned_object_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "assigned_object_id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "assigned_object_id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "assigned_object_id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "assigned_object_id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "assigned_object_id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "assigned_object_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "assigned_object_type",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "assigned_object_type__n",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "assigned_to_interface",
"schema": {
"type": "boolean"
},
"description": "Is assigned to an interface"
},
{
"in": "query",
"name": "contact",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "dns_name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "dns_name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "dns_name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "dns_name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "dns_name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "dns_name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "dns_name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "dns_name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "dns_name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "dns_name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "dns_name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "dns_name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "dns_name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "family",
"schema": {
"type": "number"
}
},
{
"in": "query",
"name": "fhrpgroup_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "FHRP group (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "fhrpgroup_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "FHRP group (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Interface (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Interface (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Interface (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Interface (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "mask_length",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mask_length__gte",
"schema": {
"type": "number"
}
},
{
"in": "query",
"name": "mask_length__lte",
"schema": {
"type": "number"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "nat_inside_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "NAT inside IP address (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "nat_inside_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "NAT inside IP address (ID)",
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "parent",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "present_in_vrf",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "present_in_vrf_id",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "role",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "10fbcb4930889b0f",
"nullable": true
}
},
"description": "The functional role of this IP",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "role__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "10fbcb4930889b0f",
"nullable": true
}
},
"description": "The functional role of this IP",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "10fbcb4930889b0f",
"nullable": true
}
},
"description": "The functional role of this IP",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "10fbcb4930889b0f",
"nullable": true
}
},
"description": "The functional role of this IP",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "10fbcb4930889b0f",
"nullable": true
}
},
"description": "The functional role of this IP",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "10fbcb4930889b0f",
"nullable": true
}
},
"description": "The functional role of this IP",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "10fbcb4930889b0f",
"nullable": true
}
},
"description": "The functional role of this IP",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "10fbcb4930889b0f",
"nullable": true
}
},
"description": "The functional role of this IP",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "10fbcb4930889b0f",
"nullable": true
}
},
"description": "The functional role of this IP",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "10fbcb4930889b0f",
"nullable": true
}
},
"description": "The functional role of this IP",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "10fbcb4930889b0f",
"nullable": true
}
},
"description": "The functional role of this IP",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "10fbcb4930889b0f",
"nullable": true
}
},
"description": "The functional role of this IP",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "service_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Application Service (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "service_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Application Service (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "24935cfee15bd268"
}
},
"description": "The operational status of this IP",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "status__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "24935cfee15bd268"
}
},
"description": "The operational status of this IP",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "24935cfee15bd268"
}
},
"description": "The operational status of this IP",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "24935cfee15bd268"
}
},
"description": "The operational status of this IP",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "24935cfee15bd268"
}
},
"description": "The operational status of this IP",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "24935cfee15bd268"
}
},
"description": "The operational status of this IP",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "24935cfee15bd268"
}
},
"description": "The operational status of this IP",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "24935cfee15bd268"
}
},
"description": "The operational status of this IP",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "24935cfee15bd268"
}
},
"description": "The operational status of this IP",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "24935cfee15bd268"
}
},
"description": "The operational status of this IP",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "24935cfee15bd268"
}
},
"description": "The operational status of this IP",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "24935cfee15bd268"
}
},
"description": "The operational status of this IP",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "virtual_machine",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_machine_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vminterface",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "VM interface (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vminterface__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "VM interface (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vminterface_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "VM interface (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vminterface_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "VM interface (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vrf",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true,
"title": "Route distinguisher"
}
},
"description": "VRF (RD)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vrf__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true,
"title": "Route distinguisher"
}
},
"description": "VRF (RD)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vrf_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "VRF",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vrf_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "VRF",
"explode": true,
"style": "form"
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedIPAddressList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "ipam_ip_addresses_create",
"description": "Post a list of IP address objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableIPAddressRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableIPAddressRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPAddress"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "ipam_ip_addresses_bulk_update",
"description": "Put a list of IP address objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPAddressRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPAddressRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPAddress"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "ipam_ip_addresses_bulk_partial_update",
"description": "Patch a list of IP address objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPAddressRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPAddressRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPAddress"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "ipam_ip_addresses_bulk_destroy",
"description": "Delete a list of IP address objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPAddressRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPAddressRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/ipam/ip-addresses/{id}/": {
"get": {
"operationId": "ipam_ip_addresses_retrieve",
"description": "Get a IP address object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this IP address.",
"required": true
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPAddress"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "ipam_ip_addresses_update",
"description": "Put a IP address object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this IP address.",
"required": true
}
],
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableIPAddressRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableIPAddressRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPAddress"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "ipam_ip_addresses_partial_update",
"description": "Patch a IP address object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this IP address.",
"required": true
}
],
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableIPAddressRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableIPAddressRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPAddress"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "ipam_ip_addresses_destroy",
"description": "Delete a IP address object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this IP address.",
"required": true
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/ipam/ip-ranges/": {
"get": {
"operationId": "ipam_ip_ranges_list",
"description": "Get a list of IP range objects.",
"parameters": [
{
"in": "query",
"name": "contact",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contains",
"schema": {
"type": "string"
},
"description": "Ranges which contain this prefix or IP"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "end_address",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "family",
"schema": {
"type": "number"
}
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "mark_populated",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "mark_utilized",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "parent",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "role",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "size",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "size__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "size__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "size__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "size__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "size__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "size__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "start_address",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "6388dfb94ca1cc15"
}
},
"description": "Operational status of this range",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "status__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "6388dfb94ca1cc15"
}
},
"description": "Operational status of this range",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "6388dfb94ca1cc15"
}
},
"description": "Operational status of this range",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "6388dfb94ca1cc15"
}
},
"description": "Operational status of this range",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "6388dfb94ca1cc15"
}
},
"description": "Operational status of this range",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "6388dfb94ca1cc15"
}
},
"description": "Operational status of this range",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "6388dfb94ca1cc15"
}
},
"description": "Operational status of this range",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "6388dfb94ca1cc15"
}
},
"description": "Operational status of this range",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "6388dfb94ca1cc15"
}
},
"description": "Operational status of this range",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "6388dfb94ca1cc15"
}
},
"description": "Operational status of this range",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "6388dfb94ca1cc15"
}
},
"description": "Operational status of this range",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "6388dfb94ca1cc15"
}
},
"description": "Operational status of this range",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "vrf",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true,
"title": "Route distinguisher"
}
},
"description": "VRF (RD)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vrf__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true,
"title": "Route distinguisher"
}
},
"description": "VRF (RD)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vrf_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "VRF",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vrf_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "VRF",
"explode": true,
"style": "form"
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedIPRangeList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "ipam_ip_ranges_create",
"description": "Post a list of IP range objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableIPRangeRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableIPRangeRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPRange"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "ipam_ip_ranges_bulk_update",
"description": "Put a list of IP range objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPRangeRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPRangeRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPRange"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "ipam_ip_ranges_bulk_partial_update",
"description": "Patch a list of IP range objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPRangeRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPRangeRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPRange"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "ipam_ip_ranges_bulk_destroy",
"description": "Delete a list of IP range objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPRangeRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPRangeRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/ipam/ip-ranges/{id}/": {
"get": {
"operationId": "ipam_ip_ranges_retrieve",
"description": "Get a IP range object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this IP range.",
"required": true
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPRange"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "ipam_ip_ranges_update",
"description": "Put a IP range object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this IP range.",
"required": true
}
],
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableIPRangeRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableIPRangeRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPRange"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "ipam_ip_ranges_partial_update",
"description": "Patch a IP range object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this IP range.",
"required": true
}
],
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableIPRangeRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableIPRangeRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPRange"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "ipam_ip_ranges_destroy",
"description": "Delete a IP range object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this IP range.",
"required": true
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/ipam/ip-ranges/{id}/available-ips/": {
"get": {
"operationId": "ipam_ip_ranges_available_ips_list",
"description": "Get a IP address object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"required": true
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AvailableIP"
}
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "ipam_ip_ranges_available_ips_create",
"description": "Post a IP address object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"required": true
}
],
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPAddressRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPAddressRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPAddress"
}
}
}
},
"description": ""
}
}
}
},
"/api/ipam/prefixes/": {
"get": {
"operationId": "ipam_prefixes_list",
"description": "Get a list of prefix objects.",
"parameters": [
{
"in": "query",
"name": "children",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "children__empty",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "children__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "children__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "children__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "children__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "children__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contains",
"schema": {
"type": "string"
},
"description": "Prefixes which contain this prefix or IP"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "depth",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "depth__empty",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "depth__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "depth__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "depth__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "depth__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "depth__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "family",
"schema": {
"type": "number"
}
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "is_pool",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "location",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mark_utilized",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "mask_length",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mask_length__gte",
"schema": {
"type": "number"
}
},
{
"in": "query",
"name": "mask_length__lte",
"schema": {
"type": "number"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "prefix",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "present_in_vrf",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "present_in_vrf_id",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "region",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "scope_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "scope_id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "scope_id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "scope_id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "scope_id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "scope_id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "scope_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "scope_type",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "scope_type__n",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "site",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d38bee5f512701d9"
}
},
"description": "Operational status of this prefix",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "status__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d38bee5f512701d9"
}
},
"description": "Operational status of this prefix",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d38bee5f512701d9"
}
},
"description": "Operational status of this prefix",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d38bee5f512701d9"
}
},
"description": "Operational status of this prefix",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d38bee5f512701d9"
}
},
"description": "Operational status of this prefix",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d38bee5f512701d9"
}
},
"description": "Operational status of this prefix",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d38bee5f512701d9"
}
},
"description": "Operational status of this prefix",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d38bee5f512701d9"
}
},
"description": "Operational status of this prefix",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d38bee5f512701d9"
}
},
"description": "Operational status of this prefix",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d38bee5f512701d9"
}
},
"description": "Operational status of this prefix",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d38bee5f512701d9"
}
},
"description": "Operational status of this prefix",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d38bee5f512701d9"
}
},
"description": "Operational status of this prefix",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "vlan_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "VLAN Group (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vlan_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "VLAN Group (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vlan_group_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "VLAN Group (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vlan_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "VLAN Group (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vlan_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "VLAN (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vlan_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "VLAN (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vlan_vid",
"schema": {
"type": "integer"
},
"description": "VLAN number (1-4094)"
},
{
"in": "query",
"name": "vlan_vid__empty",
"schema": {
"type": "integer"
},
"description": "VLAN number (1-4094)"
},
{
"in": "query",
"name": "vlan_vid__gt",
"schema": {
"type": "integer"
},
"description": "VLAN number (1-4094)"
},
{
"in": "query",
"name": "vlan_vid__gte",
"schema": {
"type": "integer"
},
"description": "VLAN number (1-4094)"
},
{
"in": "query",
"name": "vlan_vid__lt",
"schema": {
"type": "integer"
},
"description": "VLAN number (1-4094)"
},
{
"in": "query",
"name": "vlan_vid__lte",
"schema": {
"type": "integer"
},
"description": "VLAN number (1-4094)"
},
{
"in": "query",
"name": "vlan_vid__n",
"schema": {
"type": "integer"
},
"description": "VLAN number (1-4094)"
},
{
"in": "query",
"name": "vrf",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true,
"title": "Route distinguisher"
}
},
"description": "VRF (RD)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vrf__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true,
"title": "Route distinguisher"
}
},
"description": "VRF (RD)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vrf_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "VRF",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vrf_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "VRF",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "within",
"schema": {
"type": "string"
},
"description": "Within prefix"
},
{
"in": "query",
"name": "within_include",
"schema": {
"type": "string"
},
"description": "Within and including prefix"
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedPrefixList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "ipam_prefixes_create",
"description": "Post a list of prefix objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritablePrefixRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritablePrefixRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Prefix"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "ipam_prefixes_bulk_update",
"description": "Put a list of prefix objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PrefixRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PrefixRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Prefix"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "ipam_prefixes_bulk_partial_update",
"description": "Patch a list of prefix objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PrefixRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PrefixRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Prefix"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "ipam_prefixes_bulk_destroy",
"description": "Delete a list of prefix objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PrefixRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PrefixRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/ipam/prefixes/{id}/": {
"get": {
"operationId": "ipam_prefixes_retrieve",
"description": "Get a prefix object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this prefix.",
"required": true
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Prefix"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "ipam_prefixes_update",
"description": "Put a prefix object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this prefix.",
"required": true
}
],
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritablePrefixRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritablePrefixRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Prefix"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "ipam_prefixes_partial_update",
"description": "Patch a prefix object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this prefix.",
"required": true
}
],
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritablePrefixRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritablePrefixRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Prefix"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "ipam_prefixes_destroy",
"description": "Delete a prefix object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this prefix.",
"required": true
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/ipam/prefixes/{id}/available-ips/": {
"get": {
"operationId": "ipam_prefixes_available_ips_list",
"description": "Get a IP address object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"required": true
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AvailableIP"
}
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "ipam_prefixes_available_ips_create",
"description": "Post a IP address object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"required": true
}
],
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPAddressRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPAddressRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPAddress"
}
}
}
},
"description": ""
}
}
}
},
"/api/ipam/prefixes/{id}/available-prefixes/": {
"get": {
"operationId": "ipam_prefixes_available_prefixes_list",
"description": "Get a prefix object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"required": true
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AvailablePrefix"
}
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "ipam_prefixes_available_prefixes_create",
"description": "Post a prefix object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"required": true
}
],
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PrefixRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PrefixRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Prefix"
}
}
}
},
"description": ""
}
}
}
},
"/api/ipam/rirs/": {
"get": {
"operationId": "ipam_rirs_list",
"description": "Get a list of RIR objects.",
"parameters": [
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "is_private",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "slug",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "slug__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedRIRList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "ipam_rirs_create",
"description": "Post a list of RIR objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RIRRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/RIRRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RIR"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "ipam_rirs_bulk_update",
"description": "Put a list of RIR objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RIRRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RIRRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RIR"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "ipam_rirs_bulk_partial_update",
"description": "Patch a list of RIR objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RIRRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RIRRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RIR"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "ipam_rirs_bulk_destroy",
"description": "Delete a list of RIR objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RIRRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RIRRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/ipam/rirs/{id}/": {
"get": {
"operationId": "ipam_rirs_retrieve",
"description": "Get a RIR object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this RIR.",
"required": true
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RIR"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "ipam_rirs_update",
"description": "Put a RIR object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this RIR.",
"required": true
}
],
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RIRRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/RIRRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RIR"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "ipam_rirs_partial_update",
"description": "Patch a RIR object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this RIR.",
"required": true
}
],
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedRIRRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedRIRRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RIR"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "ipam_rirs_destroy",
"description": "Delete a RIR object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this RIR.",
"required": true
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/ipam/roles/": {
"get": {
"operationId": "ipam_roles_list",
"description": "Get a list of role objects.",
"parameters": [
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "slug",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "slug__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "weight",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "weight__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "weight__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedRoleList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "ipam_roles_create",
"description": "Post a list of role objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoleRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/RoleRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Role"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "ipam_roles_bulk_update",
"description": "Put a list of role objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RoleRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RoleRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Role"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "ipam_roles_bulk_partial_update",
"description": "Patch a list of role objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RoleRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RoleRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Role"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "ipam_roles_bulk_destroy",
"description": "Delete a list of role objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RoleRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RoleRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/ipam/roles/{id}/": {
"get": {
"operationId": "ipam_roles_retrieve",
"description": "Get a role object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this role.",
"required": true
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Role"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "ipam_roles_update",
"description": "Put a role object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this role.",
"required": true
}
],
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoleRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/RoleRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Role"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "ipam_roles_partial_update",
"description": "Patch a role object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this role.",
"required": true
}
],
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedRoleRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedRoleRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Role"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "ipam_roles_destroy",
"description": "Delete a role object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this role.",
"required": true
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/ipam/route-targets/": {
"get": {
"operationId": "ipam_route_targets_list",
"description": "Get a list of route target objects.",
"parameters": [
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "exporting_l2vpn",
"schema": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"format": "int64",
"nullable": true
}
},
"description": "Exporting L2VPN (identifier)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "exporting_l2vpn__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"format": "int64",
"nullable": true
}
},
"description": "Exporting L2VPN (identifier)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "exporting_l2vpn_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Exporting L2VPN",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "exporting_l2vpn_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Exporting L2VPN",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "exporting_vrf",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true,
"title": "Route distinguisher"
}
},
"description": "Export VRF (RD)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "exporting_vrf__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true,
"title": "Route distinguisher"
}
},
"description": "Export VRF (RD)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "exporting_vrf_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Exporting VRF",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "exporting_vrf_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Exporting VRF",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "importing_l2vpn",
"schema": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"format": "int64",
"nullable": true
}
},
"description": "Importing L2VPN (identifier)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "importing_l2vpn__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"format": "int64",
"nullable": true
}
},
"description": "Importing L2VPN (identifier)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "importing_l2vpn_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Importing L2VPN",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "importing_l2vpn_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Importing L2VPN",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "importing_vrf",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true,
"title": "Route distinguisher"
}
},
"description": "Import VRF (RD)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "importing_vrf__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true,
"title": "Route distinguisher"
}
},
"description": "Import VRF (RD)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "importing_vrf_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Importing VRF",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "importing_vrf_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Importing VRF",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedRouteTargetList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "ipam_route_targets_create",
"description": "Post a list of route target objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RouteTargetRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/RouteTargetRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RouteTarget"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "ipam_route_targets_bulk_update",
"description": "Put a list of route target objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RouteTargetRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RouteTargetRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RouteTarget"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "ipam_route_targets_bulk_partial_update",
"description": "Patch a list of route target objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RouteTargetRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RouteTargetRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RouteTarget"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "ipam_route_targets_bulk_destroy",
"description": "Delete a list of route target objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RouteTargetRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RouteTargetRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/ipam/route-targets/{id}/": {
"get": {
"operationId": "ipam_route_targets_retrieve",
"description": "Get a route target object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this route target.",
"required": true
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RouteTarget"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "ipam_route_targets_update",
"description": "Put a route target object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this route target.",
"required": true
}
],
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RouteTargetRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/RouteTargetRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RouteTarget"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "ipam_route_targets_partial_update",
"description": "Patch a route target object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this route target.",
"required": true
}
],
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedRouteTargetRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedRouteTargetRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RouteTarget"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "ipam_route_targets_destroy",
"description": "Delete a route target object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this route target.",
"required": true
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/ipam/service-templates/": {
"get": {
"operationId": "ipam_service_templates_list",
"description": "Get a list of application service template objects.",
"parameters": [
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "port",
"schema": {
"type": "number"
}
},
{
"in": "query",
"name": "port__empty",
"schema": {
"type": "number"
}
},
{
"in": "query",
"name": "port__gt",
"schema": {
"type": "number"
}
},
{
"in": "query",
"name": "port__gte",
"schema": {
"type": "number"
}
},
{
"in": "query",
"name": "port__lt",
"schema": {
"type": "number"
}
},
{
"in": "query",
"name": "port__lte",
"schema": {
"type": "number"
}
},
{
"in": "query",
"name": "port__n",
"schema": {
"type": "number"
}
},
{
"in": "query",
"name": "protocol",
"schema": {
"type": "string",
"x-spec-enum-id": "5521e084b1ad51de",
"enum": [
"sctp",
"tcp",
"udp"
]
},
"description": "* `tcp` - TCP\n* `udp` - UDP\n* `sctp` - SCTP"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedServiceTemplateList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "ipam_service_templates_create",
"description": "Post a list of application service template objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableServiceTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableServiceTemplateRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceTemplate"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "ipam_service_templates_bulk_update",
"description": "Put a list of application service template objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceTemplate"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "ipam_service_templates_bulk_partial_update",
"description": "Patch a list of application service template objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceTemplate"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "ipam_service_templates_bulk_destroy",
"description": "Delete a list of application service template objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceTemplateRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceTemplateRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/ipam/service-templates/{id}/": {
"get": {
"operationId": "ipam_service_templates_retrieve",
"description": "Get a application service template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this application service template.",
"required": true
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceTemplate"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "ipam_service_templates_update",
"description": "Put a application service template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this application service template.",
"required": true
}
],
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableServiceTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableServiceTemplateRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceTemplate"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "ipam_service_templates_partial_update",
"description": "Patch a application service template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this application service template.",
"required": true
}
],
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableServiceTemplateRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableServiceTemplateRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceTemplate"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "ipam_service_templates_destroy",
"description": "Delete a application service template object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this application service template.",
"required": true
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/ipam/services/": {
"get": {
"operationId": "ipam_services_list",
"description": "Get a list of application service objects.",
"parameters": [
{
"in": "query",
"name": "contact",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "fhrpgroup",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "fhrpgroup_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ip_address",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "IP address",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ip_address__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "IP address",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ip_address_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "IP address (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ip_address_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "IP address (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "parent_object_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "parent_object_id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "parent_object_id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "parent_object_id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "parent_object_id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "parent_object_id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "parent_object_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "parent_object_type",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "parent_object_type__n",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "port",
"schema": {
"type": "number"
}
},
{
"in": "query",
"name": "port__empty",
"schema": {
"type": "number"
}
},
{
"in": "query",
"name": "port__gt",
"schema": {
"type": "number"
}
},
{
"in": "query",
"name": "port__gte",
"schema": {
"type": "number"
}
},
{
"in": "query",
"name": "port__lt",
"schema": {
"type": "number"
}
},
{
"in": "query",
"name": "port__lte",
"schema": {
"type": "number"
}
},
{
"in": "query",
"name": "port__n",
"schema": {
"type": "number"
}
},
{
"in": "query",
"name": "protocol",
"schema": {
"type": "string",
"x-spec-enum-id": "5521e084b1ad51de",
"enum": [
"sctp",
"tcp",
"udp"
]
},
"description": "* `tcp` - TCP\n* `udp` - UDP\n* `sctp` - SCTP"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "virtual_machine",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_machine_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedServiceList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "ipam_services_create",
"description": "Post a list of application service objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableServiceRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableServiceRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Service"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "ipam_services_bulk_update",
"description": "Put a list of application service objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Service"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "ipam_services_bulk_partial_update",
"description": "Patch a list of application service objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Service"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "ipam_services_bulk_destroy",
"description": "Delete a list of application service objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/ipam/services/{id}/": {
"get": {
"operationId": "ipam_services_retrieve",
"description": "Get a application service object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this application service.",
"required": true
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Service"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "ipam_services_update",
"description": "Put a application service object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this application service.",
"required": true
}
],
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableServiceRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableServiceRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Service"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "ipam_services_partial_update",
"description": "Patch a application service object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this application service.",
"required": true
}
],
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableServiceRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableServiceRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Service"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "ipam_services_destroy",
"description": "Delete a application service object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this application service.",
"required": true
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/ipam/vlan-groups/": {
"get": {
"operationId": "ipam_vlan_groups_list",
"description": "Get a list of VLAN group objects.",
"parameters": [
{
"in": "query",
"name": "cluster",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "cluster_group",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "contains_vid",
"schema": {
"type": "number"
}
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "location",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "rack",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "region",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "scope_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "scope_id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "scope_id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "scope_id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "scope_id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "scope_id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "scope_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "scope_type",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "scope_type__n",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "site",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "site_group",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "slug",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "slug__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedVLANGroupList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "ipam_vlan_groups_create",
"description": "Post a list of VLAN group objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VLANGroupRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/VLANGroupRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VLANGroup"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "ipam_vlan_groups_bulk_update",
"description": "Put a list of VLAN group objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VLANGroupRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VLANGroupRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VLANGroup"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "ipam_vlan_groups_bulk_partial_update",
"description": "Patch a list of VLAN group objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VLANGroupRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VLANGroupRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VLANGroup"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "ipam_vlan_groups_bulk_destroy",
"description": "Delete a list of VLAN group objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VLANGroupRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VLANGroupRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/ipam/vlan-groups/{id}/": {
"get": {
"operationId": "ipam_vlan_groups_retrieve",
"description": "Get a VLAN group object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this VLAN group.",
"required": true
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VLANGroup"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "ipam_vlan_groups_update",
"description": "Put a VLAN group object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this VLAN group.",
"required": true
}
],
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VLANGroupRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/VLANGroupRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VLANGroup"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "ipam_vlan_groups_partial_update",
"description": "Patch a VLAN group object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this VLAN group.",
"required": true
}
],
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedVLANGroupRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedVLANGroupRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VLANGroup"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "ipam_vlan_groups_destroy",
"description": "Delete a VLAN group object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this VLAN group.",
"required": true
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/ipam/vlan-groups/{id}/available-vlans/": {
"get": {
"operationId": "ipam_vlan_groups_available_vlans_list",
"description": "Get a VLAN object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"required": true
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AvailableVLAN"
}
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "ipam_vlan_groups_available_vlans_create",
"description": "Post a VLAN object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"required": true
}
],
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VLANRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VLANRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VLAN"
}
}
}
},
"description": ""
}
}
}
},
"/api/ipam/vlan-translation-policies/": {
"get": {
"operationId": "ipam_vlan_translation_policies_list",
"description": "Get a list of VLAN translation policy objects.",
"parameters": [
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedVLANTranslationPolicyList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "ipam_vlan_translation_policies_create",
"description": "Post a list of VLAN translation policy objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VLANTranslationPolicyRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/VLANTranslationPolicyRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VLANTranslationPolicy"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "ipam_vlan_translation_policies_bulk_update",
"description": "Put a list of VLAN translation policy objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VLANTranslationPolicyRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VLANTranslationPolicyRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VLANTranslationPolicy"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "ipam_vlan_translation_policies_bulk_partial_update",
"description": "Patch a list of VLAN translation policy objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VLANTranslationPolicyRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VLANTranslationPolicyRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VLANTranslationPolicy"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "ipam_vlan_translation_policies_bulk_destroy",
"description": "Delete a list of VLAN translation policy objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VLANTranslationPolicyRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VLANTranslationPolicyRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/ipam/vlan-translation-policies/{id}/": {
"get": {
"operationId": "ipam_vlan_translation_policies_retrieve",
"description": "Get a VLAN translation policy object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this VLAN translation policy.",
"required": true
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VLANTranslationPolicy"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "ipam_vlan_translation_policies_update",
"description": "Put a VLAN translation policy object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this VLAN translation policy.",
"required": true
}
],
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VLANTranslationPolicyRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/VLANTranslationPolicyRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VLANTranslationPolicy"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "ipam_vlan_translation_policies_partial_update",
"description": "Patch a VLAN translation policy object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this VLAN translation policy.",
"required": true
}
],
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedVLANTranslationPolicyRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedVLANTranslationPolicyRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VLANTranslationPolicy"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "ipam_vlan_translation_policies_destroy",
"description": "Delete a VLAN translation policy object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this VLAN translation policy.",
"required": true
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/ipam/vlan-translation-rules/": {
"get": {
"operationId": "ipam_vlan_translation_rules_list",
"description": "Get a list of VLAN translation rule objects.",
"parameters": [
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "local_vid",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "local_vid__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "local_vid__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "local_vid__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "local_vid__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "local_vid__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "local_vid__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "policy",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "VLAN Translation Policy (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "policy__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "VLAN Translation Policy (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "policy_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "VLAN Translation Policy (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "policy_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "VLAN Translation Policy (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "remote_vid",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "remote_vid__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "remote_vid__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "remote_vid__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "remote_vid__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "remote_vid__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "remote_vid__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedVLANTranslationRuleList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "ipam_vlan_translation_rules_create",
"description": "Post a list of VLAN translation rule objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VLANTranslationRuleRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/VLANTranslationRuleRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VLANTranslationRule"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "ipam_vlan_translation_rules_bulk_update",
"description": "Put a list of VLAN translation rule objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VLANTranslationRuleRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VLANTranslationRuleRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VLANTranslationRule"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "ipam_vlan_translation_rules_bulk_partial_update",
"description": "Patch a list of VLAN translation rule objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VLANTranslationRuleRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VLANTranslationRuleRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VLANTranslationRule"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "ipam_vlan_translation_rules_bulk_destroy",
"description": "Delete a list of VLAN translation rule objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VLANTranslationRuleRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VLANTranslationRuleRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/ipam/vlan-translation-rules/{id}/": {
"get": {
"operationId": "ipam_vlan_translation_rules_retrieve",
"description": "Get a VLAN translation rule object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this VLAN translation rule.",
"required": true
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VLANTranslationRule"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "ipam_vlan_translation_rules_update",
"description": "Put a VLAN translation rule object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this VLAN translation rule.",
"required": true
}
],
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VLANTranslationRuleRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/VLANTranslationRuleRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VLANTranslationRule"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "ipam_vlan_translation_rules_partial_update",
"description": "Patch a VLAN translation rule object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this VLAN translation rule.",
"required": true
}
],
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedVLANTranslationRuleRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedVLANTranslationRuleRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VLANTranslationRule"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "ipam_vlan_translation_rules_destroy",
"description": "Delete a VLAN translation rule object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this VLAN translation rule.",
"required": true
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/ipam/vlans/": {
"get": {
"operationId": "ipam_vlans_list",
"description": "Get a list of VLAN objects.",
"parameters": [
{
"in": "query",
"name": "available_at_site",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "available_on_device",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "available_on_virtualmachine",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Group",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Group",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Group (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Group (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface_id",
"schema": {
"type": "string"
},
"description": "Assigned interface"
},
{
"in": "query",
"name": "l2vpn",
"schema": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"format": "int64",
"nullable": true
}
},
"description": "L2VPN",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "l2vpn__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"format": "int64",
"nullable": true
}
},
"description": "L2VPN",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "l2vpn_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "L2VPN (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "l2vpn_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "L2VPN (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "qinq_role",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d2510f2d3e3d3fb1",
"nullable": true,
"title": "Q-in-Q role"
}
},
"description": "Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "qinq_role__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "qinq_role__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d2510f2d3e3d3fb1",
"nullable": true,
"title": "Q-in-Q role"
}
},
"description": "Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "qinq_role__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d2510f2d3e3d3fb1",
"nullable": true,
"title": "Q-in-Q role"
}
},
"description": "Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "qinq_role__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d2510f2d3e3d3fb1",
"nullable": true,
"title": "Q-in-Q role"
}
},
"description": "Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "qinq_role__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d2510f2d3e3d3fb1",
"nullable": true,
"title": "Q-in-Q role"
}
},
"description": "Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "qinq_role__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d2510f2d3e3d3fb1",
"nullable": true,
"title": "Q-in-Q role"
}
},
"description": "Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "qinq_role__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d2510f2d3e3d3fb1",
"nullable": true,
"title": "Q-in-Q role"
}
},
"description": "Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "qinq_role__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d2510f2d3e3d3fb1",
"nullable": true,
"title": "Q-in-Q role"
}
},
"description": "Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "qinq_role__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d2510f2d3e3d3fb1",
"nullable": true,
"title": "Q-in-Q role"
}
},
"description": "Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "qinq_role__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d2510f2d3e3d3fb1",
"nullable": true,
"title": "Q-in-Q role"
}
},
"description": "Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "qinq_role__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d2510f2d3e3d3fb1",
"nullable": true,
"title": "Q-in-Q role"
}
},
"description": "Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "qinq_role__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "d2510f2d3e3d3fb1",
"nullable": true,
"title": "Q-in-Q role"
}
},
"description": "Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "qinq_svlan_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Q-in-Q SVLAN (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "qinq_svlan_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Q-in-Q SVLAN (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "qinq_svlan_vid",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "qinq_svlan_vid__empty",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "qinq_svlan_vid__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "qinq_svlan_vid__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "qinq_svlan_vid__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "qinq_svlan_vid__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "qinq_svlan_vid__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "6388dfb94ca1cc15"
}
},
"description": "Operational status of this VLAN",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "status__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "6388dfb94ca1cc15"
}
},
"description": "Operational status of this VLAN",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "6388dfb94ca1cc15"
}
},
"description": "Operational status of this VLAN",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "6388dfb94ca1cc15"
}
},
"description": "Operational status of this VLAN",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "6388dfb94ca1cc15"
}
},
"description": "Operational status of this VLAN",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "6388dfb94ca1cc15"
}
},
"description": "Operational status of this VLAN",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "6388dfb94ca1cc15"
}
},
"description": "Operational status of this VLAN",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "6388dfb94ca1cc15"
}
},
"description": "Operational status of this VLAN",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "6388dfb94ca1cc15"
}
},
"description": "Operational status of this VLAN",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "6388dfb94ca1cc15"
}
},
"description": "Operational status of this VLAN",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "6388dfb94ca1cc15"
}
},
"description": "Operational status of this VLAN",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "6388dfb94ca1cc15"
}
},
"description": "Operational status of this VLAN",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "vid",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vid__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "vid__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vid__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vid__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vid__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vid__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vminterface_id",
"schema": {
"type": "string"
},
"description": "Assigned VM interface"
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedVLANList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "ipam_vlans_create",
"description": "Post a list of VLAN objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableVLANRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableVLANRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VLAN"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "ipam_vlans_bulk_update",
"description": "Put a list of VLAN objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VLANRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VLANRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VLAN"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "ipam_vlans_bulk_partial_update",
"description": "Patch a list of VLAN objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VLANRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VLANRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VLAN"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "ipam_vlans_bulk_destroy",
"description": "Delete a list of VLAN objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VLANRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VLANRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/ipam/vlans/{id}/": {
"get": {
"operationId": "ipam_vlans_retrieve",
"description": "Get a VLAN object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this VLAN.",
"required": true
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VLAN"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "ipam_vlans_update",
"description": "Put a VLAN object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this VLAN.",
"required": true
}
],
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableVLANRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableVLANRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VLAN"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "ipam_vlans_partial_update",
"description": "Patch a VLAN object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this VLAN.",
"required": true
}
],
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableVLANRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableVLANRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VLAN"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "ipam_vlans_destroy",
"description": "Delete a VLAN object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this VLAN.",
"required": true
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/ipam/vrfs/": {
"get": {
"operationId": "ipam_vrfs_list",
"description": "Get a list of VRF objects.",
"parameters": [
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "enforce_unique",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "export_target",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Export target (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "export_target__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Export target (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "export_target_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Export target",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "export_target_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Export target",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "import_target",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Import target (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "import_target__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Import target (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "import_target_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Import target",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "import_target_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Import target",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "rd",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rd__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "rd__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rd__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rd__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rd__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rd__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rd__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rd__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rd__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rd__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rd__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "rd__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedVRFList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "ipam_vrfs_create",
"description": "Post a list of VRF objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VRFRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/VRFRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VRF"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "ipam_vrfs_bulk_update",
"description": "Put a list of VRF objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VRFRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VRFRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VRF"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "ipam_vrfs_bulk_partial_update",
"description": "Patch a list of VRF objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VRFRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VRFRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VRF"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "ipam_vrfs_bulk_destroy",
"description": "Delete a list of VRF objects.",
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VRFRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VRFRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/ipam/vrfs/{id}/": {
"get": {
"operationId": "ipam_vrfs_retrieve",
"description": "Get a VRF object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this VRF.",
"required": true
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VRF"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "ipam_vrfs_update",
"description": "Put a VRF object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this VRF.",
"required": true
}
],
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VRFRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/VRFRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VRF"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "ipam_vrfs_partial_update",
"description": "Patch a VRF object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this VRF.",
"required": true
}
],
"tags": [
"ipam"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedVRFRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedVRFRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VRF"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "ipam_vrfs_destroy",
"description": "Delete a VRF object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this VRF.",
"required": true
}
],
"tags": [
"ipam"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/schema/": {
"get": {
"operationId": "schema_retrieve",
"description": "OpenApi3 schema for this API. Format can be selected via content negotiation.\n\n- YAML: application/vnd.oai.openapi\n- JSON: application/vnd.oai.openapi+json",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"json",
"yaml"
]
}
},
{
"in": "query",
"name": "lang",
"schema": {
"type": "string",
"enum": [
"cs",
"da",
"de",
"en",
"es",
"fr",
"it",
"ja",
"nl",
"pl",
"pt",
"ru",
"tr",
"uk",
"zh"
]
}
}
],
"tags": [
"schema"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
},
{}
],
"responses": {
"200": {
"content": {
"application/vnd.oai.openapi": {
"schema": {
"type": "object",
"additionalProperties": {}
}
},
"application/yaml": {
"schema": {
"type": "object",
"additionalProperties": {}
}
},
"application/vnd.oai.openapi+json": {
"schema": {
"type": "object",
"additionalProperties": {}
}
},
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {}
}
}
},
"description": ""
}
}
}
},
"/api/status/": {
"get": {
"operationId": "status_retrieve",
"description": "A lightweight read-only endpoint for conveying NetBox's current operational status.",
"tags": [
"status"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {}
}
}
},
"description": ""
}
}
}
},
"/api/tenancy/contact-assignments/": {
"get": {
"operationId": "tenancy_contact_assignments_list",
"description": "Get a list of contact assignment objects.",
"parameters": [
{
"in": "query",
"name": "contact_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "object_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "object_id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_type",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__n",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type_id",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "object_type_id__n",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "priority",
"schema": {
"type": "string",
"x-spec-enum-id": "ef3a31644cec7524",
"nullable": true,
"enum": [
"inactive",
"primary",
"secondary",
"tertiary"
]
},
"description": "* `primary` - Primary\n* `secondary` - Secondary\n* `tertiary` - Tertiary\n* `inactive` - Inactive"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "role",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Contact role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Contact role (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact role (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"tenancy"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedContactAssignmentList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "tenancy_contact_assignments_create",
"description": "Post a list of contact assignment objects.",
"tags": [
"tenancy"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableContactAssignmentRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableContactAssignmentRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactAssignment"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "tenancy_contact_assignments_bulk_update",
"description": "Put a list of contact assignment objects.",
"tags": [
"tenancy"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactAssignmentRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactAssignmentRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactAssignment"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "tenancy_contact_assignments_bulk_partial_update",
"description": "Patch a list of contact assignment objects.",
"tags": [
"tenancy"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactAssignmentRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactAssignmentRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactAssignment"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "tenancy_contact_assignments_bulk_destroy",
"description": "Delete a list of contact assignment objects.",
"tags": [
"tenancy"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactAssignmentRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactAssignmentRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/tenancy/contact-assignments/{id}/": {
"get": {
"operationId": "tenancy_contact_assignments_retrieve",
"description": "Get a contact assignment object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this contact assignment.",
"required": true
}
],
"tags": [
"tenancy"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactAssignment"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "tenancy_contact_assignments_update",
"description": "Put a contact assignment object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this contact assignment.",
"required": true
}
],
"tags": [
"tenancy"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableContactAssignmentRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableContactAssignmentRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactAssignment"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "tenancy_contact_assignments_partial_update",
"description": "Patch a contact assignment object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this contact assignment.",
"required": true
}
],
"tags": [
"tenancy"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableContactAssignmentRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableContactAssignmentRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactAssignment"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "tenancy_contact_assignments_destroy",
"description": "Delete a contact assignment object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this contact assignment.",
"required": true
}
],
"tags": [
"tenancy"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/tenancy/contact-groups/": {
"get": {
"operationId": "tenancy_contact_groups_list",
"description": "Get a list of contact group objects.",
"parameters": [
{
"in": "query",
"name": "ancestor",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ancestor__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ancestor_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ancestor_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "parent",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Parent contact group (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "parent__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Parent contact group (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "parent_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Parent contact group (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "parent_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Parent contact group (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "slug",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "slug__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"tenancy"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedContactGroupList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "tenancy_contact_groups_create",
"description": "Post a list of contact group objects.",
"tags": [
"tenancy"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableContactGroupRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableContactGroupRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactGroup"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "tenancy_contact_groups_bulk_update",
"description": "Put a list of contact group objects.",
"tags": [
"tenancy"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactGroupRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactGroupRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactGroup"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "tenancy_contact_groups_bulk_partial_update",
"description": "Patch a list of contact group objects.",
"tags": [
"tenancy"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactGroupRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactGroupRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactGroup"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "tenancy_contact_groups_bulk_destroy",
"description": "Delete a list of contact group objects.",
"tags": [
"tenancy"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactGroupRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactGroupRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/tenancy/contact-groups/{id}/": {
"get": {
"operationId": "tenancy_contact_groups_retrieve",
"description": "Get a contact group object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this contact group.",
"required": true
}
],
"tags": [
"tenancy"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactGroup"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "tenancy_contact_groups_update",
"description": "Put a contact group object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this contact group.",
"required": true
}
],
"tags": [
"tenancy"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableContactGroupRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableContactGroupRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactGroup"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "tenancy_contact_groups_partial_update",
"description": "Patch a contact group object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this contact group.",
"required": true
}
],
"tags": [
"tenancy"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableContactGroupRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableContactGroupRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactGroup"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "tenancy_contact_groups_destroy",
"description": "Delete a contact group object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this contact group.",
"required": true
}
],
"tags": [
"tenancy"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/tenancy/contact-roles/": {
"get": {
"operationId": "tenancy_contact_roles_list",
"description": "Get a list of contact role objects.",
"parameters": [
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "slug",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "slug__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"tenancy"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedContactRoleList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "tenancy_contact_roles_create",
"description": "Post a list of contact role objects.",
"tags": [
"tenancy"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactRoleRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ContactRoleRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactRole"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "tenancy_contact_roles_bulk_update",
"description": "Put a list of contact role objects.",
"tags": [
"tenancy"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactRoleRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactRoleRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactRole"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "tenancy_contact_roles_bulk_partial_update",
"description": "Patch a list of contact role objects.",
"tags": [
"tenancy"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactRoleRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactRoleRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactRole"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "tenancy_contact_roles_bulk_destroy",
"description": "Delete a list of contact role objects.",
"tags": [
"tenancy"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactRoleRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactRoleRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/tenancy/contact-roles/{id}/": {
"get": {
"operationId": "tenancy_contact_roles_retrieve",
"description": "Get a contact role object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this contact role.",
"required": true
}
],
"tags": [
"tenancy"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactRole"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "tenancy_contact_roles_update",
"description": "Put a contact role object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this contact role.",
"required": true
}
],
"tags": [
"tenancy"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactRoleRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ContactRoleRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactRole"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "tenancy_contact_roles_partial_update",
"description": "Patch a contact role object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this contact role.",
"required": true
}
],
"tags": [
"tenancy"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedContactRoleRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedContactRoleRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactRole"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "tenancy_contact_roles_destroy",
"description": "Delete a contact role object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this contact role.",
"required": true
}
],
"tags": [
"tenancy"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/tenancy/contacts/": {
"get": {
"operationId": "tenancy_contacts_list",
"description": "Get a list of contact objects.",
"parameters": [
{
"in": "query",
"name": "address",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "address__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "address__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "address__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "address__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "address__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "address__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "address__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "address__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "address__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "address__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "address__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "address__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "email",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "email__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "email__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "email__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "email__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "email__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "email__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "email__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "email__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "email__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "email__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "email__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "email__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "link",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "link__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "link__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "link__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "link__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "link__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "link__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "link__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "link__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "link__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "link__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "link__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "link__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "phone",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "phone__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "phone__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "phone__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "phone__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "phone__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "phone__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "phone__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "phone__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "phone__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "phone__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "phone__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "phone__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "title",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "title__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "title__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "title__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "title__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "title__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "title__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "title__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "title__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "title__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "title__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "title__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "title__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"tenancy"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedContactList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "tenancy_contacts_create",
"description": "Post a list of contact objects.",
"tags": [
"tenancy"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ContactRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Contact"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "tenancy_contacts_bulk_update",
"description": "Put a list of contact objects.",
"tags": [
"tenancy"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Contact"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "tenancy_contacts_bulk_partial_update",
"description": "Patch a list of contact objects.",
"tags": [
"tenancy"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Contact"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "tenancy_contacts_bulk_destroy",
"description": "Delete a list of contact objects.",
"tags": [
"tenancy"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/tenancy/contacts/{id}/": {
"get": {
"operationId": "tenancy_contacts_retrieve",
"description": "Get a contact object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this contact.",
"required": true
}
],
"tags": [
"tenancy"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Contact"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "tenancy_contacts_update",
"description": "Put a contact object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this contact.",
"required": true
}
],
"tags": [
"tenancy"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ContactRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Contact"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "tenancy_contacts_partial_update",
"description": "Patch a contact object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this contact.",
"required": true
}
],
"tags": [
"tenancy"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedContactRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedContactRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Contact"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "tenancy_contacts_destroy",
"description": "Delete a contact object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this contact.",
"required": true
}
],
"tags": [
"tenancy"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/tenancy/tenant-groups/": {
"get": {
"operationId": "tenancy_tenant_groups_list",
"description": "Get a list of tenant group objects.",
"parameters": [
{
"in": "query",
"name": "ancestor",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ancestor__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ancestor_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ancestor_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "parent",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Parent tenant group (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "parent__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Parent tenant group (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "parent_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Parent tenant group (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "parent_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Parent tenant group (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "slug",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "slug__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"tenancy"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedTenantGroupList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "tenancy_tenant_groups_create",
"description": "Post a list of tenant group objects.",
"tags": [
"tenancy"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableTenantGroupRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableTenantGroupRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TenantGroup"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "tenancy_tenant_groups_bulk_update",
"description": "Put a list of tenant group objects.",
"tags": [
"tenancy"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TenantGroupRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TenantGroupRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TenantGroup"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "tenancy_tenant_groups_bulk_partial_update",
"description": "Patch a list of tenant group objects.",
"tags": [
"tenancy"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TenantGroupRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TenantGroupRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TenantGroup"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "tenancy_tenant_groups_bulk_destroy",
"description": "Delete a list of tenant group objects.",
"tags": [
"tenancy"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TenantGroupRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TenantGroupRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/tenancy/tenant-groups/{id}/": {
"get": {
"operationId": "tenancy_tenant_groups_retrieve",
"description": "Get a tenant group object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this tenant group.",
"required": true
}
],
"tags": [
"tenancy"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TenantGroup"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "tenancy_tenant_groups_update",
"description": "Put a tenant group object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this tenant group.",
"required": true
}
],
"tags": [
"tenancy"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableTenantGroupRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableTenantGroupRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TenantGroup"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "tenancy_tenant_groups_partial_update",
"description": "Patch a tenant group object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this tenant group.",
"required": true
}
],
"tags": [
"tenancy"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableTenantGroupRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableTenantGroupRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TenantGroup"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "tenancy_tenant_groups_destroy",
"description": "Delete a tenant group object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this tenant group.",
"required": true
}
],
"tags": [
"tenancy"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/tenancy/tenants/": {
"get": {
"operationId": "tenancy_tenants_list",
"description": "Get a list of tenant objects.",
"parameters": [
{
"in": "query",
"name": "contact",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "slug",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "slug__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"tenancy"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedTenantList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "tenancy_tenants_create",
"description": "Post a list of tenant objects.",
"tags": [
"tenancy"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TenantRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/TenantRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tenant"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "tenancy_tenants_bulk_update",
"description": "Put a list of tenant objects.",
"tags": [
"tenancy"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TenantRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TenantRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Tenant"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "tenancy_tenants_bulk_partial_update",
"description": "Patch a list of tenant objects.",
"tags": [
"tenancy"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TenantRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TenantRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Tenant"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "tenancy_tenants_bulk_destroy",
"description": "Delete a list of tenant objects.",
"tags": [
"tenancy"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TenantRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TenantRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/tenancy/tenants/{id}/": {
"get": {
"operationId": "tenancy_tenants_retrieve",
"description": "Get a tenant object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this tenant.",
"required": true
}
],
"tags": [
"tenancy"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tenant"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "tenancy_tenants_update",
"description": "Put a tenant object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this tenant.",
"required": true
}
],
"tags": [
"tenancy"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TenantRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/TenantRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tenant"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "tenancy_tenants_partial_update",
"description": "Patch a tenant object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this tenant.",
"required": true
}
],
"tags": [
"tenancy"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedTenantRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedTenantRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tenant"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "tenancy_tenants_destroy",
"description": "Delete a tenant object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this tenant.",
"required": true
}
],
"tags": [
"tenancy"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/users/config/": {
"get": {
"operationId": "users_config_retrieve",
"description": "An API endpoint via which a user can update his or her own UserConfig data (but no one else's).",
"tags": [
"users"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {}
}
}
},
"description": ""
}
}
}
},
"/api/users/groups/": {
"get": {
"operationId": "users_groups_list",
"description": "Get a list of group objects.",
"parameters": [
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "notification_group_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Notification group (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "notification_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Notification group (ID)",
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "permission_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Permission (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "permission_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Permission (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "user_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "User (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "user_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "User (ID)",
"explode": true,
"style": "form"
}
],
"tags": [
"users"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedGroupList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "users_groups_create",
"description": "Post a list of group objects.",
"tags": [
"users"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GroupRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/GroupRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Group"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "users_groups_bulk_update",
"description": "Put a list of group objects.",
"tags": [
"users"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GroupRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GroupRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Group"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "users_groups_bulk_partial_update",
"description": "Patch a list of group objects.",
"tags": [
"users"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GroupRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GroupRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Group"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "users_groups_bulk_destroy",
"description": "Delete a list of group objects.",
"tags": [
"users"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GroupRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GroupRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/users/groups/{id}/": {
"get": {
"operationId": "users_groups_retrieve",
"description": "Get a group object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this group.",
"required": true
}
],
"tags": [
"users"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Group"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "users_groups_update",
"description": "Put a group object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this group.",
"required": true
}
],
"tags": [
"users"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GroupRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/GroupRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Group"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "users_groups_partial_update",
"description": "Patch a group object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this group.",
"required": true
}
],
"tags": [
"users"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedGroupRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedGroupRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Group"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "users_groups_destroy",
"description": "Delete a group object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this group.",
"required": true
}
],
"tags": [
"users"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/users/permissions/": {
"get": {
"operationId": "users_permissions_list",
"description": "Get a list of permission objects.",
"parameters": [
{
"in": "query",
"name": "can_add",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "can_change",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "can_delete",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "can_view",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "enabled",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Group (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Group (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Group",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Group",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_type",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__ic",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__ie",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__iew",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__iregex",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__isw",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__n",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__nic",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__nie",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__niew",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__nisw",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type__regex",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "object_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_types",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "object_types__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "user",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "User (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "user__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "User (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "user_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "User",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "user_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "User",
"explode": true,
"style": "form"
}
],
"tags": [
"users"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedObjectPermissionList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "users_permissions_create",
"description": "Post a list of permission objects.",
"tags": [
"users"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectPermissionRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ObjectPermissionRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectPermission"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "users_permissions_bulk_update",
"description": "Put a list of permission objects.",
"tags": [
"users"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ObjectPermissionRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ObjectPermissionRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ObjectPermission"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "users_permissions_bulk_partial_update",
"description": "Patch a list of permission objects.",
"tags": [
"users"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ObjectPermissionRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ObjectPermissionRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ObjectPermission"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "users_permissions_bulk_destroy",
"description": "Delete a list of permission objects.",
"tags": [
"users"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ObjectPermissionRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ObjectPermissionRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/users/permissions/{id}/": {
"get": {
"operationId": "users_permissions_retrieve",
"description": "Get a permission object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this permission.",
"required": true
}
],
"tags": [
"users"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectPermission"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "users_permissions_update",
"description": "Put a permission object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this permission.",
"required": true
}
],
"tags": [
"users"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectPermissionRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ObjectPermissionRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectPermission"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "users_permissions_partial_update",
"description": "Patch a permission object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this permission.",
"required": true
}
],
"tags": [
"users"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedObjectPermissionRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedObjectPermissionRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectPermission"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "users_permissions_destroy",
"description": "Delete a permission object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this permission.",
"required": true
}
],
"tags": [
"users"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/users/tokens/": {
"get": {
"operationId": "users_tokens_list",
"description": "Get a list of token objects.",
"parameters": [
{
"in": "query",
"name": "created",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "expires",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"in": "query",
"name": "expires__gte",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"in": "query",
"name": "expires__lte",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "key",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "key__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "key__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "key__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "key__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "key__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "key__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "key__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "key__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "key__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "key__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "key__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "key__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_used",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_used__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "last_used__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_used__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_used__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_used__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_used__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "user",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "User (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "user__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "User (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "user_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "User",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "user_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "User",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "write_enabled",
"schema": {
"type": "boolean"
}
}
],
"tags": [
"users"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedTokenList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "users_tokens_create",
"description": "Post a list of token objects.",
"tags": [
"users"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TokenRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/TokenRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Token"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "users_tokens_bulk_update",
"description": "Put a list of token objects.",
"tags": [
"users"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TokenRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TokenRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Token"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "users_tokens_bulk_partial_update",
"description": "Patch a list of token objects.",
"tags": [
"users"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TokenRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TokenRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Token"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "users_tokens_bulk_destroy",
"description": "Delete a list of token objects.",
"tags": [
"users"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TokenRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TokenRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/users/tokens/{id}/": {
"get": {
"operationId": "users_tokens_retrieve",
"description": "Get a token object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this token.",
"required": true
}
],
"tags": [
"users"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Token"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "users_tokens_update",
"description": "Put a token object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this token.",
"required": true
}
],
"tags": [
"users"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TokenRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/TokenRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Token"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "users_tokens_partial_update",
"description": "Patch a token object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this token.",
"required": true
}
],
"tags": [
"users"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedTokenRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedTokenRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Token"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "users_tokens_destroy",
"description": "Delete a token object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this token.",
"required": true
}
],
"tags": [
"users"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/users/tokens/provision/": {
"post": {
"operationId": "users_tokens_provision_create",
"description": "Non-authenticated REST API endpoint via which a user may create a Token.",
"tags": [
"users"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TokenProvisionRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/TokenProvisionRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TokenProvision"
}
}
},
"description": ""
},
"401": {
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {}
}
}
},
"description": ""
}
}
}
},
"/api/users/users/": {
"get": {
"operationId": "users_users_list",
"description": "Get a list of user objects.",
"parameters": [
{
"in": "query",
"name": "date_joined",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "date_joined__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "date_joined__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "date_joined__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "date_joined__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "date_joined__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "date_joined__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "email",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "email__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "email__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "email__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "email__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "email__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "email__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "email__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "email__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "email__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "email__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "email__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "email__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "first_name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "first_name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "first_name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "first_name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "first_name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "first_name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "first_name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "first_name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "first_name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "first_name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "first_name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "first_name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "first_name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Group (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Group (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Group",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Group",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "is_active",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "is_staff",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "is_superuser",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "last_login",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_login__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "last_login__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_login__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_login__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_login__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_login__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "last_name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "notification_group_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Notification group (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "notification_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Notification group (ID)",
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "permission_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Permission (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "permission_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Permission (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "username",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "username__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "username__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "username__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "username__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "username__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "username__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "username__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "username__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "username__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "username__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "username__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "username__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
}
],
"tags": [
"users"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedUserList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "users_users_create",
"description": "Post a list of user objects.",
"tags": [
"users"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/UserRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "users_users_bulk_update",
"description": "Put a list of user objects.",
"tags": [
"users"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/User"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "users_users_bulk_partial_update",
"description": "Patch a list of user objects.",
"tags": [
"users"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/User"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "users_users_bulk_destroy",
"description": "Delete a list of user objects.",
"tags": [
"users"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/users/users/{id}/": {
"get": {
"operationId": "users_users_retrieve",
"description": "Get a user object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this user.",
"required": true
}
],
"tags": [
"users"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "users_users_update",
"description": "Put a user object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this user.",
"required": true
}
],
"tags": [
"users"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/UserRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "users_users_partial_update",
"description": "Patch a user object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this user.",
"required": true
}
],
"tags": [
"users"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedUserRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedUserRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "users_users_destroy",
"description": "Delete a user object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this user.",
"required": true
}
],
"tags": [
"users"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/virtualization/cluster-groups/": {
"get": {
"operationId": "virtualization_cluster_groups_list",
"description": "Get a list of cluster group objects.",
"parameters": [
{
"in": "query",
"name": "contact",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "slug",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "slug__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"virtualization"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedClusterGroupList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "virtualization_cluster_groups_create",
"description": "Post a list of cluster group objects.",
"tags": [
"virtualization"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClusterGroupRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ClusterGroupRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClusterGroup"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "virtualization_cluster_groups_bulk_update",
"description": "Put a list of cluster group objects.",
"tags": [
"virtualization"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClusterGroupRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClusterGroupRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClusterGroup"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "virtualization_cluster_groups_bulk_partial_update",
"description": "Patch a list of cluster group objects.",
"tags": [
"virtualization"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClusterGroupRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClusterGroupRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClusterGroup"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "virtualization_cluster_groups_bulk_destroy",
"description": "Delete a list of cluster group objects.",
"tags": [
"virtualization"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClusterGroupRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClusterGroupRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/virtualization/cluster-groups/{id}/": {
"get": {
"operationId": "virtualization_cluster_groups_retrieve",
"description": "Get a cluster group object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this cluster group.",
"required": true
}
],
"tags": [
"virtualization"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClusterGroup"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "virtualization_cluster_groups_update",
"description": "Put a cluster group object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this cluster group.",
"required": true
}
],
"tags": [
"virtualization"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClusterGroupRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ClusterGroupRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClusterGroup"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "virtualization_cluster_groups_partial_update",
"description": "Patch a cluster group object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this cluster group.",
"required": true
}
],
"tags": [
"virtualization"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedClusterGroupRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedClusterGroupRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClusterGroup"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "virtualization_cluster_groups_destroy",
"description": "Delete a cluster group object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this cluster group.",
"required": true
}
],
"tags": [
"virtualization"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/virtualization/cluster-types/": {
"get": {
"operationId": "virtualization_cluster_types_list",
"description": "Get a list of cluster type objects.",
"parameters": [
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "slug",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "slug__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"virtualization"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedClusterTypeList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "virtualization_cluster_types_create",
"description": "Post a list of cluster type objects.",
"tags": [
"virtualization"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClusterTypeRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ClusterTypeRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClusterType"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "virtualization_cluster_types_bulk_update",
"description": "Put a list of cluster type objects.",
"tags": [
"virtualization"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClusterTypeRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClusterTypeRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClusterType"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "virtualization_cluster_types_bulk_partial_update",
"description": "Patch a list of cluster type objects.",
"tags": [
"virtualization"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClusterTypeRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClusterTypeRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClusterType"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "virtualization_cluster_types_bulk_destroy",
"description": "Delete a list of cluster type objects.",
"tags": [
"virtualization"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClusterTypeRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClusterTypeRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/virtualization/cluster-types/{id}/": {
"get": {
"operationId": "virtualization_cluster_types_retrieve",
"description": "Get a cluster type object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this cluster type.",
"required": true
}
],
"tags": [
"virtualization"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClusterType"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "virtualization_cluster_types_update",
"description": "Put a cluster type object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this cluster type.",
"required": true
}
],
"tags": [
"virtualization"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClusterTypeRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ClusterTypeRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClusterType"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "virtualization_cluster_types_partial_update",
"description": "Patch a cluster type object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this cluster type.",
"required": true
}
],
"tags": [
"virtualization"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedClusterTypeRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedClusterTypeRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClusterType"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "virtualization_cluster_types_destroy",
"description": "Delete a cluster type object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this cluster type.",
"required": true
}
],
"tags": [
"virtualization"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/virtualization/clusters/": {
"get": {
"operationId": "virtualization_clusters_list",
"description": "Get a list of cluster objects.",
"parameters": [
{
"in": "query",
"name": "contact",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Parent group (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Parent group (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Parent group (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Parent group (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "location",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "region",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "scope_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "scope_id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "scope_id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "scope_id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "scope_id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "scope_id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "scope_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "scope_type",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "scope_type__n",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "site",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "79d20a734d0eecbb"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "status__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "79d20a734d0eecbb"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "79d20a734d0eecbb"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "79d20a734d0eecbb"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "79d20a734d0eecbb"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "79d20a734d0eecbb"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "79d20a734d0eecbb"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "79d20a734d0eecbb"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "79d20a734d0eecbb"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "79d20a734d0eecbb"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "79d20a734d0eecbb"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "79d20a734d0eecbb"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Cluster type (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Cluster type (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Cluster type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Cluster type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"virtualization"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedClusterList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "virtualization_clusters_create",
"description": "Post a list of cluster objects.",
"tags": [
"virtualization"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableClusterRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableClusterRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Cluster"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "virtualization_clusters_bulk_update",
"description": "Put a list of cluster objects.",
"tags": [
"virtualization"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClusterRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClusterRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Cluster"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "virtualization_clusters_bulk_partial_update",
"description": "Patch a list of cluster objects.",
"tags": [
"virtualization"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClusterRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClusterRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Cluster"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "virtualization_clusters_bulk_destroy",
"description": "Delete a list of cluster objects.",
"tags": [
"virtualization"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClusterRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClusterRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/virtualization/clusters/{id}/": {
"get": {
"operationId": "virtualization_clusters_retrieve",
"description": "Get a cluster object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this cluster.",
"required": true
}
],
"tags": [
"virtualization"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Cluster"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "virtualization_clusters_update",
"description": "Put a cluster object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this cluster.",
"required": true
}
],
"tags": [
"virtualization"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableClusterRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableClusterRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Cluster"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "virtualization_clusters_partial_update",
"description": "Patch a cluster object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this cluster.",
"required": true
}
],
"tags": [
"virtualization"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableClusterRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableClusterRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Cluster"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "virtualization_clusters_destroy",
"description": "Delete a cluster object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this cluster.",
"required": true
}
],
"tags": [
"virtualization"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/virtualization/interfaces/": {
"get": {
"operationId": "virtualization_interfaces_list",
"description": "Get a list of interface objects.",
"parameters": [
{
"in": "query",
"name": "bridge_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Bridged interface (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "bridge_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Bridged interface (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cluster",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Cluster",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cluster__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Cluster",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cluster_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Cluster (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cluster_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Cluster (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "enabled",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "l2vpn",
"schema": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"format": "int64",
"nullable": true
}
},
"description": "L2VPN",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "l2vpn__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"format": "int64",
"nullable": true
}
},
"description": "L2VPN",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "l2vpn_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "L2VPN (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "l2vpn_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "L2VPN (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "mac_address",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mode",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b6fe48fe21dbf01d",
"nullable": true
}
},
"description": "802.1Q Mode",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mode__empty",
"schema": {
"type": "boolean"
},
"description": "802.1Q Mode"
},
{
"in": "query",
"name": "mode__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b6fe48fe21dbf01d",
"nullable": true
}
},
"description": "802.1Q Mode",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mode__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b6fe48fe21dbf01d",
"nullable": true
}
},
"description": "802.1Q Mode",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mode__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b6fe48fe21dbf01d",
"nullable": true
}
},
"description": "802.1Q Mode",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mode__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b6fe48fe21dbf01d",
"nullable": true
}
},
"description": "802.1Q Mode",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mode__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b6fe48fe21dbf01d",
"nullable": true
}
},
"description": "802.1Q Mode",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mode__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b6fe48fe21dbf01d",
"nullable": true
}
},
"description": "802.1Q Mode",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mode__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b6fe48fe21dbf01d",
"nullable": true
}
},
"description": "802.1Q Mode",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mode__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b6fe48fe21dbf01d",
"nullable": true
}
},
"description": "802.1Q Mode",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mode__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b6fe48fe21dbf01d",
"nullable": true
}
},
"description": "802.1Q Mode",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mode__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b6fe48fe21dbf01d",
"nullable": true
}
},
"description": "802.1Q Mode",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mode__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b6fe48fe21dbf01d",
"nullable": true
}
},
"description": "802.1Q Mode",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "mtu",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mtu__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "mtu__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mtu__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mtu__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mtu__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mtu__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "parent_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Parent interface (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "parent_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Parent interface (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "primary_mac_address",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Primary MAC address",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "primary_mac_address__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Primary MAC address",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "primary_mac_address_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Primary MAC address (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "primary_mac_address_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Primary MAC address (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "virtual_machine",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Virtual machine",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_machine__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Virtual machine",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_machine_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual machine (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_machine_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual machine (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vlan",
"schema": {
"type": "string"
},
"description": "Assigned VID"
},
{
"in": "query",
"name": "vlan_id",
"schema": {
"type": "string"
},
"description": "Assigned VLAN"
},
{
"in": "query",
"name": "vlan_translation_policy",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "VLAN Translation Policy",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vlan_translation_policy__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "VLAN Translation Policy",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vlan_translation_policy_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "VLAN Translation Policy (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vlan_translation_policy_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "VLAN Translation Policy (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vrf",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true,
"title": "Route distinguisher"
}
},
"description": "VRF (RD)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vrf__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true,
"title": "Route distinguisher"
}
},
"description": "VRF (RD)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vrf_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "VRF",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vrf_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "VRF",
"explode": true,
"style": "form"
}
],
"tags": [
"virtualization"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedVMInterfaceList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "virtualization_interfaces_create",
"description": "Post a list of interface objects.",
"tags": [
"virtualization"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableVMInterfaceRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableVMInterfaceRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VMInterface"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "virtualization_interfaces_bulk_update",
"description": "Put a list of interface objects.",
"tags": [
"virtualization"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VMInterfaceRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VMInterfaceRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VMInterface"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "virtualization_interfaces_bulk_partial_update",
"description": "Patch a list of interface objects.",
"tags": [
"virtualization"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VMInterfaceRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VMInterfaceRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VMInterface"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "virtualization_interfaces_bulk_destroy",
"description": "Delete a list of interface objects.",
"tags": [
"virtualization"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VMInterfaceRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VMInterfaceRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/virtualization/interfaces/{id}/": {
"get": {
"operationId": "virtualization_interfaces_retrieve",
"description": "Get a interface object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this interface.",
"required": true
}
],
"tags": [
"virtualization"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VMInterface"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "virtualization_interfaces_update",
"description": "Put a interface object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this interface.",
"required": true
}
],
"tags": [
"virtualization"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableVMInterfaceRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableVMInterfaceRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VMInterface"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "virtualization_interfaces_partial_update",
"description": "Patch a interface object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this interface.",
"required": true
}
],
"tags": [
"virtualization"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableVMInterfaceRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableVMInterfaceRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VMInterface"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "virtualization_interfaces_destroy",
"description": "Delete a interface object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this interface.",
"required": true
}
],
"tags": [
"virtualization"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/virtualization/virtual-disks/": {
"get": {
"operationId": "virtualization_virtual_disks_list",
"description": "Get a list of virtual disk objects.",
"parameters": [
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "size",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "size__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "size__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "size__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "size__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "size__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "size__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "virtual_machine",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Virtual machine",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_machine__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Virtual machine",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_machine_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual machine (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_machine_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual machine (ID)",
"explode": true,
"style": "form"
}
],
"tags": [
"virtualization"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedVirtualDiskList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "virtualization_virtual_disks_create",
"description": "Post a list of virtual disk objects.",
"tags": [
"virtualization"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualDiskRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/VirtualDiskRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualDisk"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "virtualization_virtual_disks_bulk_update",
"description": "Put a list of virtual disk objects.",
"tags": [
"virtualization"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualDiskRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualDiskRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualDisk"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "virtualization_virtual_disks_bulk_partial_update",
"description": "Patch a list of virtual disk objects.",
"tags": [
"virtualization"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualDiskRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualDiskRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualDisk"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "virtualization_virtual_disks_bulk_destroy",
"description": "Delete a list of virtual disk objects.",
"tags": [
"virtualization"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualDiskRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualDiskRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/virtualization/virtual-disks/{id}/": {
"get": {
"operationId": "virtualization_virtual_disks_retrieve",
"description": "Get a virtual disk object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this virtual disk.",
"required": true
}
],
"tags": [
"virtualization"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualDisk"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "virtualization_virtual_disks_update",
"description": "Put a virtual disk object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this virtual disk.",
"required": true
}
],
"tags": [
"virtualization"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualDiskRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/VirtualDiskRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualDisk"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "virtualization_virtual_disks_partial_update",
"description": "Patch a virtual disk object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this virtual disk.",
"required": true
}
],
"tags": [
"virtualization"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedVirtualDiskRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedVirtualDiskRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualDisk"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "virtualization_virtual_disks_destroy",
"description": "Delete a virtual disk object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this virtual disk.",
"required": true
}
],
"tags": [
"virtualization"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/virtualization/virtual-machines/": {
"get": {
"operationId": "virtualization_virtual_machines_list",
"description": "Get a list of virtual machine objects.",
"parameters": [
{
"in": "query",
"name": "cluster",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Cluster",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cluster__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Cluster",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cluster_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Cluster group (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cluster_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Cluster group (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cluster_group_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Cluster group (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cluster_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Cluster group (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cluster_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Cluster (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cluster_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Cluster (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cluster_type",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Cluster type (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cluster_type__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Cluster type (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cluster_type_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Cluster type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "cluster_type_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Cluster type (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "config_template_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Config template (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "config_template_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Config template (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
},
"description": "Device",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
},
"description": "Device",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Device (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Device (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "disk",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "disk__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "disk__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "disk__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "disk__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "disk__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "disk__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "has_primary_ip",
"schema": {
"type": "boolean"
},
"description": "Has a primary IP"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface_count",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface_count__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "interface_count__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface_count__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface_count__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface_count__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface_count__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "local_context_data",
"schema": {
"type": "boolean"
},
"description": "Has local config context data"
},
{
"in": "query",
"name": "mac_address",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mac_address__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "memory",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "memory__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "memory__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "memory__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "memory__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "memory__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "memory__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "platform",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "platform__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "platform_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "platform_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "primary_ip4",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Primary IPv4 (address)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "primary_ip4__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Primary IPv4 (address)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "primary_ip4_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Primary IPv4 (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "primary_ip4_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Primary IPv4 (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "primary_ip6",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Primary IPv6 (address)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "primary_ip6__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Primary IPv6 (address)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "primary_ip6_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Primary IPv6 (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "primary_ip6_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Primary IPv6 (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "region",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "serial__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "serial__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "c649dc8de233760f"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "status__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "c649dc8de233760f"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "c649dc8de233760f"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "c649dc8de233760f"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "c649dc8de233760f"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "c649dc8de233760f"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "c649dc8de233760f"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "c649dc8de233760f"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "c649dc8de233760f"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "c649dc8de233760f"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "c649dc8de233760f"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "c649dc8de233760f"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "vcpus",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vcpus__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "vcpus__gt",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vcpus__gte",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vcpus__lt",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vcpus__lte",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vcpus__n",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_disk_count",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_disk_count__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "virtual_disk_count__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_disk_count__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_disk_count__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_disk_count__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_disk_count__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
}
],
"tags": [
"virtualization"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedVirtualMachineWithConfigContextList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "virtualization_virtual_machines_create",
"description": "Post a list of virtual machine objects.",
"tags": [
"virtualization"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableVirtualMachineWithConfigContextRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableVirtualMachineWithConfigContextRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualMachineWithConfigContext"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "virtualization_virtual_machines_bulk_update",
"description": "Put a list of virtual machine objects.",
"tags": [
"virtualization"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualMachineWithConfigContextRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualMachineWithConfigContextRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualMachineWithConfigContext"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "virtualization_virtual_machines_bulk_partial_update",
"description": "Patch a list of virtual machine objects.",
"tags": [
"virtualization"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualMachineWithConfigContextRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualMachineWithConfigContextRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualMachineWithConfigContext"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "virtualization_virtual_machines_bulk_destroy",
"description": "Delete a list of virtual machine objects.",
"tags": [
"virtualization"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualMachineWithConfigContextRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualMachineWithConfigContextRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/virtualization/virtual-machines/{id}/": {
"get": {
"operationId": "virtualization_virtual_machines_retrieve",
"description": "Get a virtual machine object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this virtual machine.",
"required": true
}
],
"tags": [
"virtualization"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualMachineWithConfigContext"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "virtualization_virtual_machines_update",
"description": "Put a virtual machine object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this virtual machine.",
"required": true
}
],
"tags": [
"virtualization"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableVirtualMachineWithConfigContextRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableVirtualMachineWithConfigContextRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualMachineWithConfigContext"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "virtualization_virtual_machines_partial_update",
"description": "Patch a virtual machine object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this virtual machine.",
"required": true
}
],
"tags": [
"virtualization"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableVirtualMachineWithConfigContextRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableVirtualMachineWithConfigContextRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualMachineWithConfigContext"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "virtualization_virtual_machines_destroy",
"description": "Delete a virtual machine object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this virtual machine.",
"required": true
}
],
"tags": [
"virtualization"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/virtualization/virtual-machines/{id}/render-config/": {
"post": {
"operationId": "virtualization_virtual_machines_render_config_create",
"description": "Resolve and render the preferred ConfigTemplate for this Device.",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"json",
"txt"
]
}
},
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this virtual machine.",
"required": true
}
],
"tags": [
"virtualization"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableVirtualMachineWithConfigContextRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableVirtualMachineWithConfigContextRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualMachineWithConfigContext"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/VirtualMachineWithConfigContext"
}
}
},
"description": ""
}
}
}
},
"/api/vpn/ike-policies/": {
"get": {
"operationId": "vpn_ike_policies_list",
"description": "Get a list of IKE policy objects.",
"parameters": [
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ike_proposal",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ike_proposal__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ike_proposal_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ike_proposal_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "mode",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "64c1be7bdb2548ca",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mode__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "mode__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "64c1be7bdb2548ca",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mode__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "64c1be7bdb2548ca",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mode__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "64c1be7bdb2548ca",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mode__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "64c1be7bdb2548ca",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mode__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "64c1be7bdb2548ca",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mode__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "64c1be7bdb2548ca",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mode__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "64c1be7bdb2548ca",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mode__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "64c1be7bdb2548ca",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mode__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "64c1be7bdb2548ca",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mode__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "64c1be7bdb2548ca",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mode__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "64c1be7bdb2548ca",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "preshared_key",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "preshared_key__ic",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "preshared_key__ie",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "preshared_key__iew",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "preshared_key__iregex",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "preshared_key__isw",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "preshared_key__n",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "preshared_key__nic",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "preshared_key__nie",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "preshared_key__niew",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "preshared_key__nisw",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "preshared_key__regex",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "version",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "00872b77916a1fde"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "version__ic",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "00872b77916a1fde"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "version__ie",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "00872b77916a1fde"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "version__iew",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "00872b77916a1fde"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "version__iregex",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "00872b77916a1fde"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "version__isw",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "00872b77916a1fde"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "version__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "00872b77916a1fde"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "version__nic",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "00872b77916a1fde"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "version__nie",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "00872b77916a1fde"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "version__niew",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "00872b77916a1fde"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "version__nisw",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "00872b77916a1fde"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "version__regex",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "00872b77916a1fde"
}
},
"explode": true,
"style": "form"
}
],
"tags": [
"vpn"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedIKEPolicyList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "vpn_ike_policies_create",
"description": "Post a list of IKE policy objects.",
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableIKEPolicyRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableIKEPolicyRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IKEPolicy"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "vpn_ike_policies_bulk_update",
"description": "Put a list of IKE policy objects.",
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IKEPolicyRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IKEPolicyRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IKEPolicy"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "vpn_ike_policies_bulk_partial_update",
"description": "Patch a list of IKE policy objects.",
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IKEPolicyRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IKEPolicyRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IKEPolicy"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "vpn_ike_policies_bulk_destroy",
"description": "Delete a list of IKE policy objects.",
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IKEPolicyRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IKEPolicyRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/vpn/ike-policies/{id}/": {
"get": {
"operationId": "vpn_ike_policies_retrieve",
"description": "Get a IKE policy object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this IKE policy.",
"required": true
}
],
"tags": [
"vpn"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IKEPolicy"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "vpn_ike_policies_update",
"description": "Put a IKE policy object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this IKE policy.",
"required": true
}
],
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableIKEPolicyRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableIKEPolicyRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IKEPolicy"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "vpn_ike_policies_partial_update",
"description": "Patch a IKE policy object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this IKE policy.",
"required": true
}
],
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableIKEPolicyRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableIKEPolicyRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IKEPolicy"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "vpn_ike_policies_destroy",
"description": "Delete a IKE policy object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this IKE policy.",
"required": true
}
],
"tags": [
"vpn"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/vpn/ike-proposals/": {
"get": {
"operationId": "vpn_ike_proposals_list",
"description": "Get a list of IKE proposal objects.",
"parameters": [
{
"in": "query",
"name": "authentication_algorithm",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0830e8839f5dea4f",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "authentication_algorithm__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "authentication_algorithm__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0830e8839f5dea4f",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "authentication_algorithm__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0830e8839f5dea4f",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "authentication_algorithm__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0830e8839f5dea4f",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "authentication_algorithm__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0830e8839f5dea4f",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "authentication_algorithm__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0830e8839f5dea4f",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "authentication_algorithm__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0830e8839f5dea4f",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "authentication_algorithm__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0830e8839f5dea4f",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "authentication_algorithm__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0830e8839f5dea4f",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "authentication_algorithm__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0830e8839f5dea4f",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "authentication_algorithm__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0830e8839f5dea4f",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "authentication_algorithm__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0830e8839f5dea4f",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "authentication_method",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "92bb2f1103b3a262"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "authentication_method__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "authentication_method__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "92bb2f1103b3a262"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "authentication_method__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "92bb2f1103b3a262"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "authentication_method__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "92bb2f1103b3a262"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "authentication_method__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "92bb2f1103b3a262"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "authentication_method__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "92bb2f1103b3a262"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "authentication_method__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "92bb2f1103b3a262"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "authentication_method__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "92bb2f1103b3a262"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "authentication_method__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "92bb2f1103b3a262"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "authentication_method__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "92bb2f1103b3a262"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "authentication_method__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "92bb2f1103b3a262"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "authentication_method__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "92bb2f1103b3a262"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "encryption_algorithm",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b022535cfdee79fe"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "encryption_algorithm__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "encryption_algorithm__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b022535cfdee79fe"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "encryption_algorithm__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b022535cfdee79fe"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "encryption_algorithm__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b022535cfdee79fe"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "encryption_algorithm__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b022535cfdee79fe"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "encryption_algorithm__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b022535cfdee79fe"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "encryption_algorithm__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b022535cfdee79fe"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "encryption_algorithm__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b022535cfdee79fe"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "encryption_algorithm__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b022535cfdee79fe"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "encryption_algorithm__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b022535cfdee79fe"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "encryption_algorithm__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b022535cfdee79fe"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "encryption_algorithm__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b022535cfdee79fe"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "dbef43be795462a8"
}
},
"description": "Diffie-Hellman group ID",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group__ic",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "dbef43be795462a8"
}
},
"description": "Diffie-Hellman group ID",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group__ie",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "dbef43be795462a8"
}
},
"description": "Diffie-Hellman group ID",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group__iew",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "dbef43be795462a8"
}
},
"description": "Diffie-Hellman group ID",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group__iregex",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "dbef43be795462a8"
}
},
"description": "Diffie-Hellman group ID",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group__isw",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "dbef43be795462a8"
}
},
"description": "Diffie-Hellman group ID",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "dbef43be795462a8"
}
},
"description": "Diffie-Hellman group ID",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group__nic",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "dbef43be795462a8"
}
},
"description": "Diffie-Hellman group ID",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group__nie",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "dbef43be795462a8"
}
},
"description": "Diffie-Hellman group ID",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group__niew",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "dbef43be795462a8"
}
},
"description": "Diffie-Hellman group ID",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group__nisw",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "dbef43be795462a8"
}
},
"description": "Diffie-Hellman group ID",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group__regex",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "dbef43be795462a8"
}
},
"description": "Diffie-Hellman group ID",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ike_policy",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "IKE policy (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ike_policy__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "IKE policy (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ike_policy_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "IKE policy (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ike_policy_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "IKE policy (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "sa_lifetime",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "sa_lifetime__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "sa_lifetime__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "sa_lifetime__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "sa_lifetime__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "sa_lifetime__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "sa_lifetime__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"vpn"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedIKEProposalList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "vpn_ike_proposals_create",
"description": "Post a list of IKE proposal objects.",
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableIKEProposalRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableIKEProposalRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IKEProposal"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "vpn_ike_proposals_bulk_update",
"description": "Put a list of IKE proposal objects.",
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IKEProposalRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IKEProposalRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IKEProposal"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "vpn_ike_proposals_bulk_partial_update",
"description": "Patch a list of IKE proposal objects.",
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IKEProposalRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IKEProposalRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IKEProposal"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "vpn_ike_proposals_bulk_destroy",
"description": "Delete a list of IKE proposal objects.",
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IKEProposalRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IKEProposalRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/vpn/ike-proposals/{id}/": {
"get": {
"operationId": "vpn_ike_proposals_retrieve",
"description": "Get a IKE proposal object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this IKE proposal.",
"required": true
}
],
"tags": [
"vpn"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IKEProposal"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "vpn_ike_proposals_update",
"description": "Put a IKE proposal object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this IKE proposal.",
"required": true
}
],
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableIKEProposalRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableIKEProposalRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IKEProposal"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "vpn_ike_proposals_partial_update",
"description": "Patch a IKE proposal object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this IKE proposal.",
"required": true
}
],
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableIKEProposalRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableIKEProposalRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IKEProposal"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "vpn_ike_proposals_destroy",
"description": "Delete a IKE proposal object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this IKE proposal.",
"required": true
}
],
"tags": [
"vpn"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/vpn/ipsec-policies/": {
"get": {
"operationId": "vpn_ipsec_policies_list",
"description": "Get a list of IPSec policy objects.",
"parameters": [
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ipsec_proposal",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ipsec_proposal__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ipsec_proposal_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ipsec_proposal_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "pfs_group",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "dbef43be795462a8",
"nullable": true
}
},
"description": "Diffie-Hellman group for Perfect Forward Secrecy",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "pfs_group__ic",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "dbef43be795462a8",
"nullable": true
}
},
"description": "Diffie-Hellman group for Perfect Forward Secrecy",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "pfs_group__ie",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "dbef43be795462a8",
"nullable": true
}
},
"description": "Diffie-Hellman group for Perfect Forward Secrecy",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "pfs_group__iew",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "dbef43be795462a8",
"nullable": true
}
},
"description": "Diffie-Hellman group for Perfect Forward Secrecy",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "pfs_group__iregex",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "dbef43be795462a8",
"nullable": true
}
},
"description": "Diffie-Hellman group for Perfect Forward Secrecy",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "pfs_group__isw",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "dbef43be795462a8",
"nullable": true
}
},
"description": "Diffie-Hellman group for Perfect Forward Secrecy",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "pfs_group__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "dbef43be795462a8",
"nullable": true
}
},
"description": "Diffie-Hellman group for Perfect Forward Secrecy",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "pfs_group__nic",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "dbef43be795462a8",
"nullable": true
}
},
"description": "Diffie-Hellman group for Perfect Forward Secrecy",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "pfs_group__nie",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "dbef43be795462a8",
"nullable": true
}
},
"description": "Diffie-Hellman group for Perfect Forward Secrecy",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "pfs_group__niew",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "dbef43be795462a8",
"nullable": true
}
},
"description": "Diffie-Hellman group for Perfect Forward Secrecy",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "pfs_group__nisw",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "dbef43be795462a8",
"nullable": true
}
},
"description": "Diffie-Hellman group for Perfect Forward Secrecy",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "pfs_group__regex",
"schema": {
"type": "array",
"items": {
"type": "integer",
"x-spec-enum-id": "dbef43be795462a8",
"nullable": true
}
},
"description": "Diffie-Hellman group for Perfect Forward Secrecy",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"vpn"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedIPSecPolicyList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "vpn_ipsec_policies_create",
"description": "Post a list of IPSec policy objects.",
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableIPSecPolicyRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableIPSecPolicyRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecPolicy"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "vpn_ipsec_policies_bulk_update",
"description": "Put a list of IPSec policy objects.",
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPSecPolicyRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPSecPolicyRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPSecPolicy"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "vpn_ipsec_policies_bulk_partial_update",
"description": "Patch a list of IPSec policy objects.",
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPSecPolicyRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPSecPolicyRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPSecPolicy"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "vpn_ipsec_policies_bulk_destroy",
"description": "Delete a list of IPSec policy objects.",
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPSecPolicyRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPSecPolicyRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/vpn/ipsec-policies/{id}/": {
"get": {
"operationId": "vpn_ipsec_policies_retrieve",
"description": "Get a IPSec policy object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this IPSec policy.",
"required": true
}
],
"tags": [
"vpn"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecPolicy"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "vpn_ipsec_policies_update",
"description": "Put a IPSec policy object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this IPSec policy.",
"required": true
}
],
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableIPSecPolicyRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableIPSecPolicyRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecPolicy"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "vpn_ipsec_policies_partial_update",
"description": "Patch a IPSec policy object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this IPSec policy.",
"required": true
}
],
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableIPSecPolicyRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableIPSecPolicyRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecPolicy"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "vpn_ipsec_policies_destroy",
"description": "Delete a IPSec policy object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this IPSec policy.",
"required": true
}
],
"tags": [
"vpn"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/vpn/ipsec-profiles/": {
"get": {
"operationId": "vpn_ipsec_profiles_list",
"description": "Get a list of IPSec profile objects.",
"parameters": [
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ike_policy",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "IKE policy (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ike_policy__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "IKE policy (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ike_policy_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "IKE policy (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ike_policy_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "IKE policy (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ipsec_policy",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "IPSec policy (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ipsec_policy__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "IPSec policy (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ipsec_policy_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "IPSec policy (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ipsec_policy_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "IPSec policy (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "mode",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "1136c2cdfee84436"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mode__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "mode__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "1136c2cdfee84436"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mode__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "1136c2cdfee84436"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mode__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "1136c2cdfee84436"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mode__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "1136c2cdfee84436"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mode__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "1136c2cdfee84436"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mode__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "1136c2cdfee84436"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mode__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "1136c2cdfee84436"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mode__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "1136c2cdfee84436"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mode__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "1136c2cdfee84436"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mode__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "1136c2cdfee84436"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "mode__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "1136c2cdfee84436"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"vpn"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedIPSecProfileList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "vpn_ipsec_profiles_create",
"description": "Post a list of IPSec profile objects.",
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableIPSecProfileRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableIPSecProfileRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecProfile"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "vpn_ipsec_profiles_bulk_update",
"description": "Put a list of IPSec profile objects.",
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPSecProfileRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPSecProfileRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPSecProfile"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "vpn_ipsec_profiles_bulk_partial_update",
"description": "Patch a list of IPSec profile objects.",
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPSecProfileRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPSecProfileRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPSecProfile"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "vpn_ipsec_profiles_bulk_destroy",
"description": "Delete a list of IPSec profile objects.",
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPSecProfileRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPSecProfileRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/vpn/ipsec-profiles/{id}/": {
"get": {
"operationId": "vpn_ipsec_profiles_retrieve",
"description": "Get a IPSec profile object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this IPSec profile.",
"required": true
}
],
"tags": [
"vpn"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecProfile"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "vpn_ipsec_profiles_update",
"description": "Put a IPSec profile object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this IPSec profile.",
"required": true
}
],
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableIPSecProfileRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableIPSecProfileRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecProfile"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "vpn_ipsec_profiles_partial_update",
"description": "Patch a IPSec profile object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this IPSec profile.",
"required": true
}
],
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableIPSecProfileRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableIPSecProfileRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecProfile"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "vpn_ipsec_profiles_destroy",
"description": "Delete a IPSec profile object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this IPSec profile.",
"required": true
}
],
"tags": [
"vpn"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/vpn/ipsec-proposals/": {
"get": {
"operationId": "vpn_ipsec_proposals_list",
"description": "Get a list of IPSec proposal objects.",
"parameters": [
{
"in": "query",
"name": "authentication_algorithm",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0830e8839f5dea4f",
"nullable": true,
"title": "Authentication"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "authentication_algorithm__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "authentication_algorithm__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0830e8839f5dea4f",
"nullable": true,
"title": "Authentication"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "authentication_algorithm__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0830e8839f5dea4f",
"nullable": true,
"title": "Authentication"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "authentication_algorithm__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0830e8839f5dea4f",
"nullable": true,
"title": "Authentication"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "authentication_algorithm__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0830e8839f5dea4f",
"nullable": true,
"title": "Authentication"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "authentication_algorithm__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0830e8839f5dea4f",
"nullable": true,
"title": "Authentication"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "authentication_algorithm__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0830e8839f5dea4f",
"nullable": true,
"title": "Authentication"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "authentication_algorithm__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0830e8839f5dea4f",
"nullable": true,
"title": "Authentication"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "authentication_algorithm__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0830e8839f5dea4f",
"nullable": true,
"title": "Authentication"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "authentication_algorithm__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0830e8839f5dea4f",
"nullable": true,
"title": "Authentication"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "authentication_algorithm__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0830e8839f5dea4f",
"nullable": true,
"title": "Authentication"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "authentication_algorithm__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0830e8839f5dea4f",
"nullable": true,
"title": "Authentication"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "encryption_algorithm",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b022535cfdee79fe",
"nullable": true,
"title": "Encryption"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "encryption_algorithm__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "encryption_algorithm__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b022535cfdee79fe",
"nullable": true,
"title": "Encryption"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "encryption_algorithm__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b022535cfdee79fe",
"nullable": true,
"title": "Encryption"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "encryption_algorithm__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b022535cfdee79fe",
"nullable": true,
"title": "Encryption"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "encryption_algorithm__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b022535cfdee79fe",
"nullable": true,
"title": "Encryption"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "encryption_algorithm__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b022535cfdee79fe",
"nullable": true,
"title": "Encryption"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "encryption_algorithm__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b022535cfdee79fe",
"nullable": true,
"title": "Encryption"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "encryption_algorithm__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b022535cfdee79fe",
"nullable": true,
"title": "Encryption"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "encryption_algorithm__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b022535cfdee79fe",
"nullable": true,
"title": "Encryption"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "encryption_algorithm__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b022535cfdee79fe",
"nullable": true,
"title": "Encryption"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "encryption_algorithm__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b022535cfdee79fe",
"nullable": true,
"title": "Encryption"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "encryption_algorithm__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "b022535cfdee79fe",
"nullable": true,
"title": "Encryption"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ipsec_policy",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "IPSec policy (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ipsec_policy__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "IPSec policy (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ipsec_policy_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "IPSec policy (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ipsec_policy_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "IPSec policy (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "sa_lifetime_data",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "sa_lifetime_data__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "sa_lifetime_data__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "sa_lifetime_data__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "sa_lifetime_data__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "sa_lifetime_data__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "sa_lifetime_data__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "sa_lifetime_seconds",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "sa_lifetime_seconds__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "sa_lifetime_seconds__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "sa_lifetime_seconds__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "sa_lifetime_seconds__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "sa_lifetime_seconds__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "sa_lifetime_seconds__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"vpn"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedIPSecProposalList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "vpn_ipsec_proposals_create",
"description": "Post a list of IPSec proposal objects.",
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableIPSecProposalRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableIPSecProposalRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecProposal"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "vpn_ipsec_proposals_bulk_update",
"description": "Put a list of IPSec proposal objects.",
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPSecProposalRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPSecProposalRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPSecProposal"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "vpn_ipsec_proposals_bulk_partial_update",
"description": "Patch a list of IPSec proposal objects.",
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPSecProposalRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPSecProposalRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPSecProposal"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "vpn_ipsec_proposals_bulk_destroy",
"description": "Delete a list of IPSec proposal objects.",
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPSecProposalRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPSecProposalRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/vpn/ipsec-proposals/{id}/": {
"get": {
"operationId": "vpn_ipsec_proposals_retrieve",
"description": "Get a IPSec proposal object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this IPSec proposal.",
"required": true
}
],
"tags": [
"vpn"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecProposal"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "vpn_ipsec_proposals_update",
"description": "Put a IPSec proposal object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this IPSec proposal.",
"required": true
}
],
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableIPSecProposalRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableIPSecProposalRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecProposal"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "vpn_ipsec_proposals_partial_update",
"description": "Patch a IPSec proposal object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this IPSec proposal.",
"required": true
}
],
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableIPSecProposalRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableIPSecProposalRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IPSecProposal"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "vpn_ipsec_proposals_destroy",
"description": "Delete a IPSec proposal object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this IPSec proposal.",
"required": true
}
],
"tags": [
"vpn"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/vpn/l2vpn-terminations/": {
"get": {
"operationId": "vpn_l2vpn_terminations_list",
"description": "Get a list of L2VPN termination objects.",
"parameters": [
{
"in": "query",
"name": "assigned_object_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "assigned_object_id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "assigned_object_id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "assigned_object_id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "assigned_object_id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "assigned_object_id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "assigned_object_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "assigned_object_type",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "assigned_object_type__n",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "device",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
},
"description": "Device (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
},
"description": "Device (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "device_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Device (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Interface (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Interface (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Interface (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Interface (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "l2vpn",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "L2VPN (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "l2vpn__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "L2VPN (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "l2vpn_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "L2VPN (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "l2vpn_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "L2VPN (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "region",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "virtual_machine",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Virtual machine (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_machine__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Virtual machine (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_machine_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual machine (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "virtual_machine_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Virtual machine (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vlan",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "VLAN (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vlan__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "VLAN (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vlan_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "VLAN (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vlan_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "VLAN (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vlan_vid",
"schema": {
"type": "integer"
},
"description": "VLAN number (1-4094)"
},
{
"in": "query",
"name": "vlan_vid__empty",
"schema": {
"type": "integer"
},
"description": "VLAN number (1-4094)"
},
{
"in": "query",
"name": "vlan_vid__gt",
"schema": {
"type": "integer"
},
"description": "VLAN number (1-4094)"
},
{
"in": "query",
"name": "vlan_vid__gte",
"schema": {
"type": "integer"
},
"description": "VLAN number (1-4094)"
},
{
"in": "query",
"name": "vlan_vid__lt",
"schema": {
"type": "integer"
},
"description": "VLAN number (1-4094)"
},
{
"in": "query",
"name": "vlan_vid__lte",
"schema": {
"type": "integer"
},
"description": "VLAN number (1-4094)"
},
{
"in": "query",
"name": "vlan_vid__n",
"schema": {
"type": "integer"
},
"description": "VLAN number (1-4094)"
},
{
"in": "query",
"name": "vminterface",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "VM interface (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vminterface__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "VM interface (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vminterface_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "VM Interface (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vminterface_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "VM Interface (ID)",
"explode": true,
"style": "form"
}
],
"tags": [
"vpn"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedL2VPNTerminationList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "vpn_l2vpn_terminations_create",
"description": "Post a list of L2VPN termination objects.",
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/L2VPNTerminationRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/L2VPNTerminationRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/L2VPNTermination"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "vpn_l2vpn_terminations_bulk_update",
"description": "Put a list of L2VPN termination objects.",
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/L2VPNTerminationRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/L2VPNTerminationRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/L2VPNTermination"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "vpn_l2vpn_terminations_bulk_partial_update",
"description": "Patch a list of L2VPN termination objects.",
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/L2VPNTerminationRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/L2VPNTerminationRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/L2VPNTermination"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "vpn_l2vpn_terminations_bulk_destroy",
"description": "Delete a list of L2VPN termination objects.",
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/L2VPNTerminationRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/L2VPNTerminationRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/vpn/l2vpn-terminations/{id}/": {
"get": {
"operationId": "vpn_l2vpn_terminations_retrieve",
"description": "Get a L2VPN termination object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this L2VPN termination.",
"required": true
}
],
"tags": [
"vpn"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/L2VPNTermination"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "vpn_l2vpn_terminations_update",
"description": "Put a L2VPN termination object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this L2VPN termination.",
"required": true
}
],
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/L2VPNTerminationRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/L2VPNTerminationRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/L2VPNTermination"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "vpn_l2vpn_terminations_partial_update",
"description": "Patch a L2VPN termination object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this L2VPN termination.",
"required": true
}
],
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedL2VPNTerminationRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedL2VPNTerminationRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/L2VPNTermination"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "vpn_l2vpn_terminations_destroy",
"description": "Delete a L2VPN termination object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this L2VPN termination.",
"required": true
}
],
"tags": [
"vpn"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/vpn/l2vpns/": {
"get": {
"operationId": "vpn_l2vpns_list",
"description": "Get a list of L2VPN objects.",
"parameters": [
{
"in": "query",
"name": "contact",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "export_target",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Export target (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "export_target__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Export target (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "export_target_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Export target",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "export_target_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Export target",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "identifier",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "identifier__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "identifier__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "identifier__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "identifier__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "identifier__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "identifier__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "import_target",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Import target (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "import_target__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Import target (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "import_target_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Import target",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "import_target_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Import target",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "slug",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "slug__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "937bacafb9d5d4bb"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "status__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "937bacafb9d5d4bb"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "937bacafb9d5d4bb"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "937bacafb9d5d4bb"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "937bacafb9d5d4bb"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "937bacafb9d5d4bb"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "937bacafb9d5d4bb"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "937bacafb9d5d4bb"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "937bacafb9d5d4bb"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "937bacafb9d5d4bb"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "937bacafb9d5d4bb"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "937bacafb9d5d4bb"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "730136816a2885f9"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "type__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "730136816a2885f9"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "730136816a2885f9"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "730136816a2885f9"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "730136816a2885f9"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "730136816a2885f9"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "730136816a2885f9"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "730136816a2885f9"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "730136816a2885f9"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "730136816a2885f9"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "730136816a2885f9"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "type__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "730136816a2885f9"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"vpn"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedL2VPNList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "vpn_l2vpns_create",
"description": "Post a list of L2VPN objects.",
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableL2VPNRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableL2VPNRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/L2VPN"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "vpn_l2vpns_bulk_update",
"description": "Put a list of L2VPN objects.",
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/L2VPNRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/L2VPNRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/L2VPN"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "vpn_l2vpns_bulk_partial_update",
"description": "Patch a list of L2VPN objects.",
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/L2VPNRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/L2VPNRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/L2VPN"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "vpn_l2vpns_bulk_destroy",
"description": "Delete a list of L2VPN objects.",
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/L2VPNRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/L2VPNRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/vpn/l2vpns/{id}/": {
"get": {
"operationId": "vpn_l2vpns_retrieve",
"description": "Get a L2VPN object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this L2VPN.",
"required": true
}
],
"tags": [
"vpn"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/L2VPN"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "vpn_l2vpns_update",
"description": "Put a L2VPN object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this L2VPN.",
"required": true
}
],
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableL2VPNRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableL2VPNRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/L2VPN"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "vpn_l2vpns_partial_update",
"description": "Patch a L2VPN object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this L2VPN.",
"required": true
}
],
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableL2VPNRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableL2VPNRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/L2VPN"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "vpn_l2vpns_destroy",
"description": "Delete a L2VPN object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this L2VPN.",
"required": true
}
],
"tags": [
"vpn"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/vpn/tunnel-groups/": {
"get": {
"operationId": "vpn_tunnel_groups_list",
"description": "Get a list of tunnel group objects.",
"parameters": [
{
"in": "query",
"name": "contact",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "slug",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "slug__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"vpn"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedTunnelGroupList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "vpn_tunnel_groups_create",
"description": "Post a list of tunnel group objects.",
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TunnelGroupRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/TunnelGroupRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TunnelGroup"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "vpn_tunnel_groups_bulk_update",
"description": "Put a list of tunnel group objects.",
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TunnelGroupRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TunnelGroupRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TunnelGroup"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "vpn_tunnel_groups_bulk_partial_update",
"description": "Patch a list of tunnel group objects.",
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TunnelGroupRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TunnelGroupRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TunnelGroup"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "vpn_tunnel_groups_bulk_destroy",
"description": "Delete a list of tunnel group objects.",
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TunnelGroupRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TunnelGroupRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/vpn/tunnel-groups/{id}/": {
"get": {
"operationId": "vpn_tunnel_groups_retrieve",
"description": "Get a tunnel group object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this tunnel group.",
"required": true
}
],
"tags": [
"vpn"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TunnelGroup"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "vpn_tunnel_groups_update",
"description": "Put a tunnel group object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this tunnel group.",
"required": true
}
],
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TunnelGroupRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/TunnelGroupRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TunnelGroup"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "vpn_tunnel_groups_partial_update",
"description": "Patch a tunnel group object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this tunnel group.",
"required": true
}
],
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedTunnelGroupRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedTunnelGroupRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TunnelGroup"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "vpn_tunnel_groups_destroy",
"description": "Delete a tunnel group object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this tunnel group.",
"required": true
}
],
"tags": [
"vpn"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/vpn/tunnel-terminations/": {
"get": {
"operationId": "vpn_tunnel_terminations_list",
"description": "Get a list of tunnel termination objects.",
"parameters": [
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Interface (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Interface (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Interface (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Interface (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "outside_ip_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Outside IP (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "outside_ip_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Outside IP (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "role",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "52225cd60b867572"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "role__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "52225cd60b867572"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "52225cd60b867572"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "52225cd60b867572"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "52225cd60b867572"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "52225cd60b867572"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "52225cd60b867572"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "52225cd60b867572"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "52225cd60b867572"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "52225cd60b867572"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "52225cd60b867572"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "role__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "52225cd60b867572"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "termination_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "termination_id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "termination_id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "termination_id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "termination_id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "termination_id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "termination_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "termination_type",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "termination_type__n",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "tunnel",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tunnel (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tunnel__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tunnel (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tunnel_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Tunnel (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tunnel_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Tunnel (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "vminterface",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "VM interface (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vminterface__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "VM interface (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vminterface_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "VM interface (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vminterface_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "VM interface (ID)",
"explode": true,
"style": "form"
}
],
"tags": [
"vpn"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedTunnelTerminationList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "vpn_tunnel_terminations_create",
"description": "Post a list of tunnel termination objects.",
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableTunnelTerminationRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableTunnelTerminationRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TunnelTermination"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "vpn_tunnel_terminations_bulk_update",
"description": "Put a list of tunnel termination objects.",
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TunnelTerminationRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TunnelTerminationRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TunnelTermination"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "vpn_tunnel_terminations_bulk_partial_update",
"description": "Patch a list of tunnel termination objects.",
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TunnelTerminationRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TunnelTerminationRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TunnelTermination"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "vpn_tunnel_terminations_bulk_destroy",
"description": "Delete a list of tunnel termination objects.",
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TunnelTerminationRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TunnelTerminationRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/vpn/tunnel-terminations/{id}/": {
"get": {
"operationId": "vpn_tunnel_terminations_retrieve",
"description": "Get a tunnel termination object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this tunnel termination.",
"required": true
}
],
"tags": [
"vpn"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TunnelTermination"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "vpn_tunnel_terminations_update",
"description": "Put a tunnel termination object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this tunnel termination.",
"required": true
}
],
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableTunnelTerminationRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableTunnelTerminationRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TunnelTermination"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "vpn_tunnel_terminations_partial_update",
"description": "Patch a tunnel termination object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this tunnel termination.",
"required": true
}
],
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableTunnelTerminationRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableTunnelTerminationRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TunnelTermination"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "vpn_tunnel_terminations_destroy",
"description": "Delete a tunnel termination object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this tunnel termination.",
"required": true
}
],
"tags": [
"vpn"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/vpn/tunnels/": {
"get": {
"operationId": "vpn_tunnels_list",
"description": "Get a list of tunnel objects.",
"parameters": [
{
"in": "query",
"name": "contact",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "contact_role__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Contact Role",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "encapsulation",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "54a2e45824009c49"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "encapsulation__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "encapsulation__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "54a2e45824009c49"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "encapsulation__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "54a2e45824009c49"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "encapsulation__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "54a2e45824009c49"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "encapsulation__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "54a2e45824009c49"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "encapsulation__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "54a2e45824009c49"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "encapsulation__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "54a2e45824009c49"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "encapsulation__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "54a2e45824009c49"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "encapsulation__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "54a2e45824009c49"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "encapsulation__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "54a2e45824009c49"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "encapsulation__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "54a2e45824009c49"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "encapsulation__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "54a2e45824009c49"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tunnel group (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tunnel group (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tunnel group (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tunnel group (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ipsec_profile",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "IPSec profile (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ipsec_profile__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "IPSec profile (name)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ipsec_profile_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "IPSec profile (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ipsec_profile_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "IPSec profile (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "status",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0d65f7912cba74aa"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "status__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0d65f7912cba74aa"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0d65f7912cba74aa"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0d65f7912cba74aa"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0d65f7912cba74aa"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0d65f7912cba74aa"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0d65f7912cba74aa"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0d65f7912cba74aa"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0d65f7912cba74aa"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0d65f7912cba74aa"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0d65f7912cba74aa"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "0d65f7912cba74aa"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tunnel_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tunnel_id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "tunnel_id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tunnel_id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tunnel_id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tunnel_id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tunnel_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"vpn"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedTunnelList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "vpn_tunnels_create",
"description": "Post a list of tunnel objects.",
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableTunnelRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableTunnelRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tunnel"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "vpn_tunnels_bulk_update",
"description": "Put a list of tunnel objects.",
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TunnelRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TunnelRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Tunnel"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "vpn_tunnels_bulk_partial_update",
"description": "Patch a list of tunnel objects.",
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TunnelRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TunnelRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Tunnel"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "vpn_tunnels_bulk_destroy",
"description": "Delete a list of tunnel objects.",
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TunnelRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TunnelRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/vpn/tunnels/{id}/": {
"get": {
"operationId": "vpn_tunnels_retrieve",
"description": "Get a tunnel object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this tunnel.",
"required": true
}
],
"tags": [
"vpn"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tunnel"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "vpn_tunnels_update",
"description": "Put a tunnel object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this tunnel.",
"required": true
}
],
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableTunnelRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableTunnelRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tunnel"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "vpn_tunnels_partial_update",
"description": "Patch a tunnel object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this tunnel.",
"required": true
}
],
"tags": [
"vpn"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableTunnelRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableTunnelRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tunnel"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "vpn_tunnels_destroy",
"description": "Delete a tunnel object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this tunnel.",
"required": true
}
],
"tags": [
"vpn"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/wireless/wireless-lan-groups/": {
"get": {
"operationId": "wireless_wireless_lan_groups_list",
"description": "Get a list of wireless LAN group objects.",
"parameters": [
{
"in": "query",
"name": "ancestor",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ancestor__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ancestor_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ancestor_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "name",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "name__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "name__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "parent",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "parent__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "parent_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "parent_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "slug",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "slug__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "slug__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"wireless"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedWirelessLANGroupList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "wireless_wireless_lan_groups_create",
"description": "Post a list of wireless LAN group objects.",
"tags": [
"wireless"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableWirelessLANGroupRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableWirelessLANGroupRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WirelessLANGroup"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "wireless_wireless_lan_groups_bulk_update",
"description": "Put a list of wireless LAN group objects.",
"tags": [
"wireless"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WirelessLANGroupRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WirelessLANGroupRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WirelessLANGroup"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "wireless_wireless_lan_groups_bulk_partial_update",
"description": "Patch a list of wireless LAN group objects.",
"tags": [
"wireless"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WirelessLANGroupRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WirelessLANGroupRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WirelessLANGroup"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "wireless_wireless_lan_groups_bulk_destroy",
"description": "Delete a list of wireless LAN group objects.",
"tags": [
"wireless"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WirelessLANGroupRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WirelessLANGroupRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/wireless/wireless-lan-groups/{id}/": {
"get": {
"operationId": "wireless_wireless_lan_groups_retrieve",
"description": "Get a wireless LAN group object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this wireless LAN group.",
"required": true
}
],
"tags": [
"wireless"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WirelessLANGroup"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "wireless_wireless_lan_groups_update",
"description": "Put a wireless LAN group object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this wireless LAN group.",
"required": true
}
],
"tags": [
"wireless"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableWirelessLANGroupRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableWirelessLANGroupRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WirelessLANGroup"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "wireless_wireless_lan_groups_partial_update",
"description": "Patch a wireless LAN group object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this wireless LAN group.",
"required": true
}
],
"tags": [
"wireless"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableWirelessLANGroupRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableWirelessLANGroupRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WirelessLANGroup"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "wireless_wireless_lan_groups_destroy",
"description": "Delete a wireless LAN group object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this wireless LAN group.",
"required": true
}
],
"tags": [
"wireless"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/wireless/wireless-lans/": {
"get": {
"operationId": "wireless_wireless_lans_list",
"description": "Get a list of wireless LAN objects.",
"parameters": [
{
"in": "query",
"name": "auth_cipher",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8fdaefa727c26fdc",
"nullable": true,
"title": "Authentication cipher"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_cipher__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "auth_cipher__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8fdaefa727c26fdc",
"nullable": true,
"title": "Authentication cipher"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_cipher__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8fdaefa727c26fdc",
"nullable": true,
"title": "Authentication cipher"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_cipher__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8fdaefa727c26fdc",
"nullable": true,
"title": "Authentication cipher"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_cipher__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8fdaefa727c26fdc",
"nullable": true,
"title": "Authentication cipher"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_cipher__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8fdaefa727c26fdc",
"nullable": true,
"title": "Authentication cipher"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_cipher__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8fdaefa727c26fdc",
"nullable": true,
"title": "Authentication cipher"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_cipher__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8fdaefa727c26fdc",
"nullable": true,
"title": "Authentication cipher"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_cipher__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8fdaefa727c26fdc",
"nullable": true,
"title": "Authentication cipher"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_cipher__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8fdaefa727c26fdc",
"nullable": true,
"title": "Authentication cipher"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_cipher__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8fdaefa727c26fdc",
"nullable": true,
"title": "Authentication cipher"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_cipher__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8fdaefa727c26fdc",
"nullable": true,
"title": "Authentication cipher"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_psk",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_psk__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "auth_psk__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_psk__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_psk__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_psk__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_psk__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_psk__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_psk__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_psk__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_psk__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_psk__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_psk__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_type",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a2043acb899b3954",
"nullable": true,
"title": "Authentication type"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_type__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "auth_type__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a2043acb899b3954",
"nullable": true,
"title": "Authentication type"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_type__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a2043acb899b3954",
"nullable": true,
"title": "Authentication type"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_type__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a2043acb899b3954",
"nullable": true,
"title": "Authentication type"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_type__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a2043acb899b3954",
"nullable": true,
"title": "Authentication type"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_type__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a2043acb899b3954",
"nullable": true,
"title": "Authentication type"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_type__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a2043acb899b3954",
"nullable": true,
"title": "Authentication type"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_type__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a2043acb899b3954",
"nullable": true,
"title": "Authentication type"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_type__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a2043acb899b3954",
"nullable": true,
"title": "Authentication type"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_type__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a2043acb899b3954",
"nullable": true,
"title": "Authentication type"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_type__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a2043acb899b3954",
"nullable": true,
"title": "Authentication type"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_type__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a2043acb899b3954",
"nullable": true,
"title": "Authentication type"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "location",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "location_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "region",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "region_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "scope_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "scope_id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "scope_id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "scope_id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "scope_id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "scope_id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "scope_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "scope_type",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "scope_type__n",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "site",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Site (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "site_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": "Site (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ssid",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ssid__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "ssid__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ssid__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ssid__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ssid__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ssid__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ssid__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ssid__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ssid__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ssid__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ssid__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ssid__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "412ebdca597f609e"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "status__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "412ebdca597f609e"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "412ebdca597f609e"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "412ebdca597f609e"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "412ebdca597f609e"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "412ebdca597f609e"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "412ebdca597f609e"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "412ebdca597f609e"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "412ebdca597f609e"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "412ebdca597f609e"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "412ebdca597f609e"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "412ebdca597f609e"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "vlan_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "vlan_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"explode": true,
"style": "form"
}
],
"tags": [
"wireless"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedWirelessLANList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "wireless_wireless_lans_create",
"description": "Post a list of wireless LAN objects.",
"tags": [
"wireless"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableWirelessLANRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableWirelessLANRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WirelessLAN"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "wireless_wireless_lans_bulk_update",
"description": "Put a list of wireless LAN objects.",
"tags": [
"wireless"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WirelessLANRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WirelessLANRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WirelessLAN"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "wireless_wireless_lans_bulk_partial_update",
"description": "Patch a list of wireless LAN objects.",
"tags": [
"wireless"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WirelessLANRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WirelessLANRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WirelessLAN"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "wireless_wireless_lans_bulk_destroy",
"description": "Delete a list of wireless LAN objects.",
"tags": [
"wireless"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WirelessLANRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WirelessLANRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/wireless/wireless-lans/{id}/": {
"get": {
"operationId": "wireless_wireless_lans_retrieve",
"description": "Get a wireless LAN object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this wireless LAN.",
"required": true
}
],
"tags": [
"wireless"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WirelessLAN"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "wireless_wireless_lans_update",
"description": "Put a wireless LAN object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this wireless LAN.",
"required": true
}
],
"tags": [
"wireless"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableWirelessLANRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableWirelessLANRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WirelessLAN"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "wireless_wireless_lans_partial_update",
"description": "Patch a wireless LAN object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this wireless LAN.",
"required": true
}
],
"tags": [
"wireless"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableWirelessLANRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableWirelessLANRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WirelessLAN"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "wireless_wireless_lans_destroy",
"description": "Delete a wireless LAN object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this wireless LAN.",
"required": true
}
],
"tags": [
"wireless"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/wireless/wireless-links/": {
"get": {
"operationId": "wireless_wireless_links_list",
"description": "Get a list of wireless link objects.",
"parameters": [
{
"in": "query",
"name": "auth_cipher",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8fdaefa727c26fdc",
"nullable": true,
"title": "Authentication cipher"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_cipher__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "auth_cipher__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8fdaefa727c26fdc",
"nullable": true,
"title": "Authentication cipher"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_cipher__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8fdaefa727c26fdc",
"nullable": true,
"title": "Authentication cipher"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_cipher__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8fdaefa727c26fdc",
"nullable": true,
"title": "Authentication cipher"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_cipher__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8fdaefa727c26fdc",
"nullable": true,
"title": "Authentication cipher"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_cipher__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8fdaefa727c26fdc",
"nullable": true,
"title": "Authentication cipher"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_cipher__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8fdaefa727c26fdc",
"nullable": true,
"title": "Authentication cipher"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_cipher__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8fdaefa727c26fdc",
"nullable": true,
"title": "Authentication cipher"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_cipher__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8fdaefa727c26fdc",
"nullable": true,
"title": "Authentication cipher"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_cipher__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8fdaefa727c26fdc",
"nullable": true,
"title": "Authentication cipher"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_cipher__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8fdaefa727c26fdc",
"nullable": true,
"title": "Authentication cipher"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_cipher__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "8fdaefa727c26fdc",
"nullable": true,
"title": "Authentication cipher"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_psk",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_psk__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "auth_psk__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_psk__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_psk__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_psk__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_psk__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_psk__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_psk__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_psk__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_psk__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_psk__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_psk__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_type",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a2043acb899b3954",
"nullable": true,
"title": "Authentication type"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_type__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "auth_type__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a2043acb899b3954",
"nullable": true,
"title": "Authentication type"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_type__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a2043acb899b3954",
"nullable": true,
"title": "Authentication type"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_type__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a2043acb899b3954",
"nullable": true,
"title": "Authentication type"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_type__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a2043acb899b3954",
"nullable": true,
"title": "Authentication type"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_type__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a2043acb899b3954",
"nullable": true,
"title": "Authentication type"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_type__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a2043acb899b3954",
"nullable": true,
"title": "Authentication type"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_type__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a2043acb899b3954",
"nullable": true,
"title": "Authentication type"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_type__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a2043acb899b3954",
"nullable": true,
"title": "Authentication type"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_type__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a2043acb899b3954",
"nullable": true,
"title": "Authentication type"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_type__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a2043acb899b3954",
"nullable": true,
"title": "Authentication type"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "auth_type__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "a2043acb899b3954",
"nullable": true,
"title": "Authentication type"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "created_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "description",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "description__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "description__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "distance",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "distance__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "distance__gt",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "distance__gte",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "distance__lt",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "distance__lte",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "distance__n",
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "distance_unit",
"schema": {
"type": "string",
"x-spec-enum-id": "53542e7902f946af",
"nullable": true,
"enum": [
"ft",
"km",
"m",
"mi"
]
},
"description": "* `km` - Kilometers\n* `m` - Meters\n* `mi` - Miles\n* `ft` - Feet"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id__gt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__gte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lt",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__lte",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface_a_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface_a_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface_b_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "interface_b_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__empty",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__gte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lt",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__lte",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "last_updated__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
},
"explode": true,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "modified_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"description": "Search"
},
{
"in": "query",
"name": "ssid",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ssid__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "ssid__ic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ssid__ie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ssid__iew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ssid__iregex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ssid__isw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ssid__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ssid__nic",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ssid__nie",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ssid__niew",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ssid__nisw",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "ssid__regex",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "fbc2f302c08be50d"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__empty",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "status__ic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "fbc2f302c08be50d"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__ie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "fbc2f302c08be50d"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__iew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "fbc2f302c08be50d"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__iregex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "fbc2f302c08be50d"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__isw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "fbc2f302c08be50d"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__n",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "fbc2f302c08be50d"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nic",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "fbc2f302c08be50d"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nie",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "fbc2f302c08be50d"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__niew",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "fbc2f302c08be50d"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__nisw",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "fbc2f302c08be50d"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "status__regex",
"schema": {
"type": "array",
"items": {
"type": "string",
"x-spec-enum-id": "fbc2f302c08be50d"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tag_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Tenant (slug)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_group_id__n",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "tenant_id__n",
"schema": {
"type": "array",
"items": {
"type": "integer",
"nullable": true
}
},
"description": "Tenant (ID)",
"explode": true,
"style": "form"
},
{
"in": "query",
"name": "updated_by_request",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"tags": [
"wireless"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedWirelessLinkList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "wireless_wireless_links_create",
"description": "Post a list of wireless link objects.",
"tags": [
"wireless"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableWirelessLinkRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableWirelessLinkRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WirelessLink"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "wireless_wireless_links_bulk_update",
"description": "Put a list of wireless link objects.",
"tags": [
"wireless"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WirelessLinkRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WirelessLinkRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WirelessLink"
}
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "wireless_wireless_links_bulk_partial_update",
"description": "Patch a list of wireless link objects.",
"tags": [
"wireless"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WirelessLinkRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WirelessLinkRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WirelessLink"
}
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "wireless_wireless_links_bulk_destroy",
"description": "Delete a list of wireless link objects.",
"tags": [
"wireless"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WirelessLinkRequest"
}
}
},
"multipart/form-data": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WirelessLinkRequest"
}
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/wireless/wireless-links/{id}/": {
"get": {
"operationId": "wireless_wireless_links_retrieve",
"description": "Get a wireless link object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this wireless link.",
"required": true
}
],
"tags": [
"wireless"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WirelessLink"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "wireless_wireless_links_update",
"description": "Put a wireless link object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this wireless link.",
"required": true
}
],
"tags": [
"wireless"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WritableWirelessLinkRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WritableWirelessLinkRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WirelessLink"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "wireless_wireless_links_partial_update",
"description": "Patch a wireless link object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this wireless link.",
"required": true
}
],
"tags": [
"wireless"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableWirelessLinkRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWritableWirelessLinkRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WirelessLink"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "wireless_wireless_links_destroy",
"description": "Delete a wireless link object.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this wireless link.",
"required": true
}
],
"tags": [
"wireless"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
}
},
"components": {
"schemas": {
"ASN": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"asn": {
"type": "integer",
"maximum": 4294967295,
"minimum": 1,
"format": "int64",
"description": "16- or 32-bit autonomous system number"
},
"rir": {
"allOf": [
{
"$ref": "#/components/schemas/BriefRIR"
}
],
"nullable": true
},
"tenant": {
"allOf": [
{
"$ref": "#/components/schemas/BriefTenant"
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"site_count": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"provider_count": {
"type": "integer",
"format": "int64",
"readOnly": true
}
},
"required": [
"asn",
"created",
"display",
"display_url",
"id",
"last_updated",
"provider_count",
"site_count",
"url"
]
},
"ASNRange": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"rir": {
"$ref": "#/components/schemas/BriefRIR"
},
"start": {
"type": "integer",
"maximum": 4294967295,
"minimum": 1,
"format": "int64"
},
"end": {
"type": "integer",
"maximum": 4294967295,
"minimum": 1,
"format": "int64"
},
"tenant": {
"allOf": [
{
"$ref": "#/components/schemas/BriefTenant"
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"asn_count": {
"type": "integer",
"readOnly": true
}
},
"required": [
"asn_count",
"created",
"display",
"display_url",
"end",
"id",
"last_updated",
"name",
"rir",
"slug",
"start",
"url"
]
},
"ASNRangeRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"rir": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefRIRRequest"
}
]
},
"start": {
"type": "integer",
"maximum": 4294967295,
"minimum": 1,
"format": "int64"
},
"end": {
"type": "integer",
"maximum": 4294967295,
"minimum": 1,
"format": "int64"
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"end",
"name",
"rir",
"slug",
"start"
]
},
"ASNRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"asn": {
"type": "integer",
"maximum": 4294967295,
"minimum": 1,
"format": "int64",
"description": "16- or 32-bit autonomous system number"
},
"rir": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefRIRRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"asn"
]
},
"Aggregate": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"family": {
"type": "object",
"properties": {
"value": {
"enum": [
4,
6
],
"type": "integer",
"description": "* `4` - IPv4\n* `6` - IPv6",
"x-spec-enum-id": "d72003fd1af3603d"
},
"label": {
"type": "string",
"enum": [
"IPv4",
"IPv6"
]
}
},
"readOnly": true
},
"prefix": {
"type": "string"
},
"rir": {
"$ref": "#/components/schemas/BriefRIR"
},
"tenant": {
"allOf": [
{
"$ref": "#/components/schemas/BriefTenant"
}
],
"nullable": true
},
"date_added": {
"type": "string",
"format": "date",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"created",
"display",
"display_url",
"family",
"id",
"last_updated",
"prefix",
"rir",
"url"
]
},
"AggregateRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"prefix": {
"type": "string",
"minLength": 1
},
"rir": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefRIRRequest"
}
]
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"date_added": {
"type": "string",
"format": "date",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"prefix",
"rir"
]
},
"AvailableASN": {
"type": "object",
"description": "Representation of an ASN which does not exist in the database.",
"properties": {
"asn": {
"type": "integer",
"readOnly": true
},
"description": {
"type": "string"
}
},
"required": [
"asn"
]
},
"AvailableIP": {
"type": "object",
"description": "Representation of an IP address which does not exist in the database.",
"properties": {
"family": {
"type": "integer",
"readOnly": true
},
"address": {
"type": "string",
"readOnly": true
},
"vrf": {
"allOf": [
{
"$ref": "#/components/schemas/BriefVRF"
}
],
"readOnly": true,
"nullable": true
},
"description": {
"type": "string"
}
},
"required": [
"address",
"family",
"vrf"
]
},
"AvailablePrefix": {
"type": "object",
"description": "Representation of a prefix which does not exist in the database.",
"properties": {
"family": {
"type": "integer",
"readOnly": true
},
"prefix": {
"type": "string",
"readOnly": true
},
"vrf": {
"allOf": [
{
"$ref": "#/components/schemas/BriefVRF"
}
],
"readOnly": true,
"nullable": true
}
},
"required": [
"family",
"prefix",
"vrf"
]
},
"AvailableVLAN": {
"type": "object",
"description": "Representation of a VLAN which does not exist in the database.",
"properties": {
"vid": {
"type": "integer",
"readOnly": true
},
"group": {
"allOf": [
{
"$ref": "#/components/schemas/BriefVLANGroup"
}
],
"readOnly": true,
"nullable": true
}
},
"required": [
"group",
"vid"
]
},
"Bookmark": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"object_type": {
"type": "string"
},
"object_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64"
},
"object": {
"nullable": true,
"readOnly": true
},
"user": {
"$ref": "#/components/schemas/BriefUser"
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true
}
},
"required": [
"created",
"display",
"id",
"object",
"object_id",
"object_type",
"url",
"user"
]
},
"BookmarkRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"object_type": {
"type": "string"
},
"object_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64"
},
"user": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefUserRequest"
}
]
}
},
"required": [
"object_id",
"object_type",
"user"
]
},
"BriefCable": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"label": {
"type": "string",
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"display",
"id",
"url"
]
},
"BriefCableRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"label": {
"type": "string",
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
}
}
},
"BriefCircuit": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"cid": {
"type": "string",
"title": "Circuit ID",
"description": "Unique circuit ID",
"maxLength": 100
},
"provider": {
"$ref": "#/components/schemas/BriefProvider"
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"cid",
"display",
"id",
"provider",
"url"
]
},
"BriefCircuitGroup": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
}
},
"required": [
"display",
"id",
"name",
"url"
]
},
"BriefCircuitGroupAssignmentSerializer_": {
"type": "object",
"description": "Base serializer for group assignments under CircuitSerializer.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"group": {
"$ref": "#/components/schemas/BriefCircuitGroup"
},
"priority": {
"type": "object",
"properties": {
"value": {
"enum": [
"primary",
"secondary",
"tertiary",
"inactive",
""
],
"type": "string",
"description": "* `primary` - Primary\n* `secondary` - Secondary\n* `tertiary` - Tertiary\n* `inactive` - Inactive",
"x-spec-enum-id": "ef3a31644cec7524"
},
"label": {
"type": "string",
"enum": [
"Primary",
"Secondary",
"Tertiary",
"Inactive"
]
}
}
}
},
"required": [
"display",
"group",
"id",
"url"
]
},
"BriefCircuitGroupAssignmentSerializer_Request": {
"type": "object",
"description": "Base serializer for group assignments under CircuitSerializer.",
"properties": {
"group": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefCircuitGroupRequest"
}
]
},
"priority": {
"enum": [
"primary",
"secondary",
"tertiary",
"inactive",
""
],
"type": "string",
"description": "* `primary` - Primary\n* `secondary` - Secondary\n* `tertiary` - Tertiary\n* `inactive` - Inactive",
"x-spec-enum-id": "ef3a31644cec7524"
}
},
"required": [
"group"
]
},
"BriefCircuitGroupRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
}
},
"required": [
"name"
]
},
"BriefCircuitRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"cid": {
"type": "string",
"minLength": 1,
"title": "Circuit ID",
"description": "Unique circuit ID",
"maxLength": 100
},
"provider": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefProviderRequest"
}
]
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"cid",
"provider"
]
},
"BriefCircuitType": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
},
"circuit_count": {
"type": "integer",
"format": "int64",
"readOnly": true
}
},
"required": [
"circuit_count",
"display",
"id",
"name",
"slug",
"url"
]
},
"BriefCircuitTypeRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name",
"slug"
]
},
"BriefCluster": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"virtualmachine_count": {
"type": "integer",
"format": "int64",
"readOnly": true
}
},
"required": [
"display",
"id",
"name",
"url",
"virtualmachine_count"
]
},
"BriefClusterGroup": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
},
"cluster_count": {
"type": "integer",
"format": "int64",
"readOnly": true
}
},
"required": [
"cluster_count",
"display",
"id",
"name",
"slug",
"url"
]
},
"BriefClusterGroupRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name",
"slug"
]
},
"BriefClusterRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name"
]
},
"BriefClusterType": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
},
"cluster_count": {
"type": "integer",
"format": "int64",
"readOnly": true
}
},
"required": [
"cluster_count",
"display",
"id",
"name",
"slug",
"url"
]
},
"BriefClusterTypeRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name",
"slug"
]
},
"BriefConfigContextProfile": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"display",
"id",
"name",
"url"
]
},
"BriefConfigContextProfileRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name"
]
},
"BriefConfigTemplate": {
"type": "object",
"description": "Introduces support for Tag assignment. Adds `tags` serialization, and handles tag assignment\non create() and update().",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"display",
"id",
"name",
"url"
]
},
"BriefConfigTemplateRequest": {
"type": "object",
"description": "Introduces support for Tag assignment. Adds `tags` serialization, and handles tag assignment\non create() and update().",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name"
]
},
"BriefContact": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"display",
"id",
"name",
"url"
]
},
"BriefContactRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name"
]
},
"BriefContactRole": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"display",
"id",
"name",
"slug",
"url"
]
},
"BriefContactRoleRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name",
"slug"
]
},
"BriefCustomFieldChoiceSet": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"choices_count": {
"type": "string",
"readOnly": true
}
},
"required": [
"choices_count",
"display",
"id",
"name",
"url"
]
},
"BriefCustomFieldChoiceSetRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name"
]
},
"BriefDataFile": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"path": {
"type": "string",
"readOnly": true,
"description": "File path relative to the data source's root"
}
},
"required": [
"display",
"id",
"path",
"url"
]
},
"BriefDataSource": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"display",
"id",
"name",
"url"
]
},
"BriefDataSourceRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name"
]
},
"BriefDevice": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"nullable": true,
"maxLength": 64
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"display",
"id",
"url"
]
},
"BriefDeviceRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"nullable": true,
"maxLength": 64
},
"description": {
"type": "string",
"maxLength": 200
}
}
},
"BriefDeviceRole": {
"type": "object",
"description": "Extends PrimaryModelSerializer to include MPTT support.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
},
"device_count": {
"type": "integer",
"readOnly": true,
"default": 0
},
"virtualmachine_count": {
"type": "integer",
"readOnly": true,
"default": 0
},
"_depth": {
"type": "integer",
"readOnly": true,
"title": " depth"
}
},
"required": [
"_depth",
"device_count",
"display",
"id",
"name",
"slug",
"url",
"virtualmachine_count"
]
},
"BriefDeviceRoleRequest": {
"type": "object",
"description": "Extends PrimaryModelSerializer to include MPTT support.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name",
"slug"
]
},
"BriefDeviceType": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"manufacturer": {
"$ref": "#/components/schemas/BriefManufacturer"
},
"model": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
},
"device_count": {
"type": "integer",
"format": "int64",
"readOnly": true
}
},
"required": [
"device_count",
"display",
"id",
"manufacturer",
"model",
"slug",
"url"
]
},
"BriefDeviceTypeRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"manufacturer": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefManufacturerRequest"
}
]
},
"model": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"manufacturer",
"model",
"slug"
]
},
"BriefFHRPGroup": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"protocol": {
"enum": [
"vrrp2",
"vrrp3",
"carp",
"clusterxl",
"hsrp",
"glbp",
"other"
],
"type": "string",
"description": "* `vrrp2` - VRRPv2\n* `vrrp3` - VRRPv3\n* `carp` - CARP\n* `clusterxl` - ClusterXL\n* `hsrp` - HSRP\n* `glbp` - GLBP\n* `other` - Other",
"x-spec-enum-id": "40dc831c689b4b78"
},
"group_id": {
"type": "integer",
"maximum": 32767,
"minimum": 0
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"display",
"group_id",
"id",
"protocol",
"url"
]
},
"BriefFHRPGroupRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"protocol": {
"enum": [
"vrrp2",
"vrrp3",
"carp",
"clusterxl",
"hsrp",
"glbp",
"other"
],
"type": "string",
"description": "* `vrrp2` - VRRPv2\n* `vrrp3` - VRRPv3\n* `carp` - CARP\n* `clusterxl` - ClusterXL\n* `hsrp` - HSRP\n* `glbp` - GLBP\n* `other` - Other",
"x-spec-enum-id": "40dc831c689b4b78"
},
"group_id": {
"type": "integer",
"maximum": 32767,
"minimum": 0
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"group_id",
"protocol"
]
},
"BriefIKEPolicy": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"display",
"id",
"name",
"url"
]
},
"BriefIKEPolicyRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name"
]
},
"BriefIPAddress": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"family": {
"type": "object",
"properties": {
"value": {
"enum": [
4,
6
],
"type": "integer",
"description": "* `4` - IPv4\n* `6` - IPv6",
"x-spec-enum-id": "d72003fd1af3603d"
},
"label": {
"type": "string",
"enum": [
"IPv4",
"IPv6"
]
}
},
"readOnly": true
},
"address": {
"type": "string"
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"address",
"display",
"family",
"id",
"url"
]
},
"BriefIPAddressRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"address": {
"type": "string",
"minLength": 1
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"address"
]
},
"BriefIPSecPolicy": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"display",
"id",
"name",
"url"
]
},
"BriefIPSecPolicyRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name"
]
},
"BriefIPSecProfile": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"display",
"id",
"name",
"url"
]
},
"BriefIPSecProfileRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name"
]
},
"BriefInterface": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"device": {
"$ref": "#/components/schemas/BriefDevice"
},
"name": {
"type": "string",
"maxLength": 64
},
"description": {
"type": "string",
"maxLength": 200
},
"cable": {
"allOf": [
{
"$ref": "#/components/schemas/BriefCable"
}
],
"readOnly": true,
"nullable": true
},
"_occupied": {
"type": "boolean",
"readOnly": true,
"title": " occupied"
}
},
"required": [
"_occupied",
"cable",
"device",
"display",
"id",
"name",
"url"
]
},
"BriefInterfaceRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"device": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDeviceRequest"
}
]
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"device",
"name"
]
},
"BriefInventoryItemRole": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
},
"inventoryitem_count": {
"type": "integer",
"format": "int64",
"readOnly": true
}
},
"required": [
"display",
"id",
"inventoryitem_count",
"name",
"slug",
"url"
]
},
"BriefInventoryItemRoleRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name",
"slug"
]
},
"BriefJob": {
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"status": {
"type": "object",
"properties": {
"value": {
"enum": [
"pending",
"scheduled",
"running",
"completed",
"errored",
"failed"
],
"type": "string",
"description": "* `pending` - Pending\n* `scheduled` - Scheduled\n* `running` - Running\n* `completed` - Completed\n* `errored` - Errored\n* `failed` - Failed",
"x-spec-enum-id": "e33887d83efcc138"
},
"label": {
"type": "string",
"enum": [
"Pending",
"Scheduled",
"Running",
"Completed",
"Errored",
"Failed"
]
}
},
"readOnly": true
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"completed": {
"type": "string",
"format": "date-time",
"nullable": true
},
"user": {
"allOf": [
{
"$ref": "#/components/schemas/BriefUser"
}
],
"readOnly": true
}
},
"required": [
"created",
"status",
"url",
"user"
]
},
"BriefJobRequest": {
"type": "object",
"properties": {
"completed": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
},
"BriefL2VPN": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"identifier": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"format": "int64",
"nullable": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"type": {
"type": "object",
"properties": {
"value": {
"enum": [
"vpws",
"vpls",
"vxlan",
"vxlan-evpn",
"mpls-evpn",
"pbb-evpn",
"evpn-vpws",
"epl",
"evpl",
"ep-lan",
"evp-lan",
"ep-tree",
"evp-tree",
"spb"
],
"type": "string",
"description": "* `vpws` - VPWS\n* `vpls` - VPLS\n* `vxlan` - VXLAN\n* `vxlan-evpn` - VXLAN-EVPN\n* `mpls-evpn` - MPLS EVPN\n* `pbb-evpn` - PBB EVPN\n* `evpn-vpws` - EVPN VPWS\n* `epl` - EPL\n* `evpl` - EVPL\n* `ep-lan` - Ethernet Private LAN\n* `evp-lan` - Ethernet Virtual Private LAN\n* `ep-tree` - Ethernet Private Tree\n* `evp-tree` - Ethernet Virtual Private Tree\n* `spb` - SPB",
"x-spec-enum-id": "730136816a2885f9"
},
"label": {
"type": "string",
"enum": [
"VPWS",
"VPLS",
"VXLAN",
"VXLAN-EVPN",
"MPLS EVPN",
"PBB EVPN",
"EVPN VPWS",
"EPL",
"EVPL",
"Ethernet Private LAN",
"Ethernet Virtual Private LAN",
"Ethernet Private Tree",
"Ethernet Virtual Private Tree",
"SPB"
]
}
}
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"display",
"id",
"name",
"slug",
"url"
]
},
"BriefL2VPNRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"identifier": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"format": "int64",
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"type": {
"enum": [
"vpws",
"vpls",
"vxlan",
"vxlan-evpn",
"mpls-evpn",
"pbb-evpn",
"evpn-vpws",
"epl",
"evpl",
"ep-lan",
"evp-lan",
"ep-tree",
"evp-tree",
"spb"
],
"type": "string",
"description": "* `vpws` - VPWS\n* `vpls` - VPLS\n* `vxlan` - VXLAN\n* `vxlan-evpn` - VXLAN-EVPN\n* `mpls-evpn` - MPLS EVPN\n* `pbb-evpn` - PBB EVPN\n* `evpn-vpws` - EVPN VPWS\n* `epl` - EPL\n* `evpl` - EVPL\n* `ep-lan` - Ethernet Private LAN\n* `evp-lan` - Ethernet Virtual Private LAN\n* `ep-tree` - Ethernet Private Tree\n* `evp-tree` - Ethernet Virtual Private Tree\n* `spb` - SPB",
"x-spec-enum-id": "730136816a2885f9"
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name",
"slug"
]
},
"BriefL2VPNTermination": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"l2vpn": {
"$ref": "#/components/schemas/BriefL2VPN"
}
},
"required": [
"display",
"id",
"l2vpn",
"url"
]
},
"BriefL2VPNTerminationRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"l2vpn": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefL2VPNRequest"
}
]
}
},
"required": [
"l2vpn"
]
},
"BriefLocation": {
"type": "object",
"description": "Extends PrimaryModelSerializer to include MPTT support.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
},
"rack_count": {
"type": "integer",
"readOnly": true,
"default": 0
},
"_depth": {
"type": "integer",
"readOnly": true,
"title": " depth"
}
},
"required": [
"_depth",
"display",
"id",
"name",
"rack_count",
"slug",
"url"
]
},
"BriefLocationRequest": {
"type": "object",
"description": "Extends PrimaryModelSerializer to include MPTT support.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name",
"slug"
]
},
"BriefMACAddress": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"mac_address": {
"type": "string"
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"display",
"id",
"mac_address",
"url"
]
},
"BriefMACAddressRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"mac_address": {
"type": "string"
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"mac_address"
]
},
"BriefManufacturer": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
},
"devicetype_count": {
"type": "integer",
"format": "int64",
"readOnly": true
}
},
"required": [
"devicetype_count",
"display",
"id",
"name",
"slug",
"url"
]
},
"BriefManufacturerRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name",
"slug"
]
},
"BriefModule": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"device": {
"$ref": "#/components/schemas/BriefDevice"
},
"module_bay": {
"$ref": "#/components/schemas/NestedModuleBay"
}
},
"required": [
"device",
"display",
"id",
"module_bay",
"url"
]
},
"BriefModuleRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"device": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDeviceRequest"
}
]
},
"module_bay": {
"$ref": "#/components/schemas/NestedModuleBayRequest"
}
},
"required": [
"device",
"module_bay"
]
},
"BriefModuleType": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"profile": {
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleTypeProfile"
}
],
"nullable": true
},
"manufacturer": {
"$ref": "#/components/schemas/BriefManufacturer"
},
"model": {
"type": "string",
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"display",
"id",
"manufacturer",
"model",
"url"
]
},
"BriefModuleTypeProfile": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"display",
"id",
"name",
"url"
]
},
"BriefModuleTypeProfileRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name"
]
},
"BriefModuleTypeRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"profile": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleTypeProfileRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"manufacturer": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefManufacturerRequest"
}
]
},
"model": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"manufacturer",
"model"
]
},
"BriefPlatform": {
"type": "object",
"description": "Extends PrimaryModelSerializer to include MPTT support.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
},
"device_count": {
"type": "integer",
"readOnly": true,
"default": 0
},
"virtualmachine_count": {
"type": "integer",
"readOnly": true,
"default": 0
},
"_depth": {
"type": "integer",
"readOnly": true,
"title": " depth"
}
},
"required": [
"_depth",
"device_count",
"display",
"id",
"name",
"slug",
"url",
"virtualmachine_count"
]
},
"BriefPlatformRequest": {
"type": "object",
"description": "Extends PrimaryModelSerializer to include MPTT support.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name",
"slug"
]
},
"BriefPowerPanel": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"powerfeed_count": {
"type": "integer",
"format": "int64",
"readOnly": true
}
},
"required": [
"display",
"id",
"name",
"powerfeed_count",
"url"
]
},
"BriefPowerPanelRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name"
]
},
"BriefPowerPort": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"device": {
"$ref": "#/components/schemas/BriefDevice"
},
"name": {
"type": "string",
"maxLength": 64
},
"description": {
"type": "string",
"maxLength": 200
},
"cable": {
"allOf": [
{
"$ref": "#/components/schemas/BriefCable"
}
],
"readOnly": true,
"nullable": true
},
"_occupied": {
"type": "boolean",
"readOnly": true,
"title": " occupied"
}
},
"required": [
"_occupied",
"cable",
"device",
"display",
"id",
"name",
"url"
]
},
"BriefPowerPortRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"device": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDeviceRequest"
}
]
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"device",
"name"
]
},
"BriefPowerPortTemplate": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"description": "{module} is accepted as a substitution for the module bay position when attached to a module type.",
"maxLength": 64
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"display",
"id",
"name",
"url"
]
},
"BriefPowerPortTemplateRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"description": "{module} is accepted as a substitution for the module bay position when attached to a module type.",
"maxLength": 64
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name"
]
},
"BriefProvider": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"description": "Full name of the provider",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
},
"circuit_count": {
"type": "integer",
"format": "int64",
"readOnly": true
}
},
"required": [
"circuit_count",
"display",
"id",
"name",
"slug",
"url"
]
},
"BriefProviderAccount": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"default": "",
"maxLength": 100
},
"account": {
"type": "string",
"title": "Account ID",
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"account",
"display",
"id",
"url"
]
},
"BriefProviderAccountRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"default": "",
"maxLength": 100
},
"account": {
"type": "string",
"minLength": 1,
"title": "Account ID",
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"account"
]
},
"BriefProviderNetwork": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"display",
"id",
"name",
"url"
]
},
"BriefProviderNetworkRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name"
]
},
"BriefProviderRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"description": "Full name of the provider",
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name",
"slug"
]
},
"BriefRIR": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
},
"aggregate_count": {
"type": "integer",
"format": "int64",
"readOnly": true
}
},
"required": [
"aggregate_count",
"display",
"id",
"name",
"slug",
"url"
]
},
"BriefRIRRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name",
"slug"
]
},
"BriefRack": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"device_count": {
"type": "integer",
"format": "int64",
"readOnly": true
}
},
"required": [
"device_count",
"display",
"id",
"name",
"url"
]
},
"BriefRackRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name"
]
},
"BriefRackRole": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
},
"rack_count": {
"type": "integer",
"format": "int64",
"readOnly": true
}
},
"required": [
"display",
"id",
"name",
"rack_count",
"slug",
"url"
]
},
"BriefRackRoleRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name",
"slug"
]
},
"BriefRackType": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"manufacturer": {
"$ref": "#/components/schemas/BriefManufacturer"
},
"model": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"display",
"id",
"manufacturer",
"model",
"slug",
"url"
]
},
"BriefRackTypeRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"manufacturer": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefManufacturerRequest"
}
]
},
"model": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"manufacturer",
"model",
"slug"
]
},
"BriefRearPortTemplate": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"description": "{module} is accepted as a substitution for the module bay position when attached to a module type.",
"maxLength": 64
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"display",
"id",
"name",
"url"
]
},
"BriefRearPortTemplateRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"description": "{module} is accepted as a substitution for the module bay position when attached to a module type.",
"maxLength": 64
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name"
]
},
"BriefRegion": {
"type": "object",
"description": "Extends PrimaryModelSerializer to include MPTT support.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
},
"site_count": {
"type": "integer",
"readOnly": true,
"default": 0
},
"_depth": {
"type": "integer",
"readOnly": true,
"title": " depth"
}
},
"required": [
"_depth",
"display",
"id",
"name",
"site_count",
"slug",
"url"
]
},
"BriefRegionRequest": {
"type": "object",
"description": "Extends PrimaryModelSerializer to include MPTT support.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name",
"slug"
]
},
"BriefRole": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
},
"prefix_count": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"vlan_count": {
"type": "integer",
"format": "int64",
"readOnly": true
}
},
"required": [
"display",
"id",
"name",
"prefix_count",
"slug",
"url",
"vlan_count"
]
},
"BriefRoleRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name",
"slug"
]
},
"BriefSite": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"description": "Full name of the site",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"display",
"id",
"name",
"slug",
"url"
]
},
"BriefSiteGroup": {
"type": "object",
"description": "Extends PrimaryModelSerializer to include MPTT support.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
},
"site_count": {
"type": "integer",
"readOnly": true,
"default": 0
},
"_depth": {
"type": "integer",
"readOnly": true,
"title": " depth"
}
},
"required": [
"_depth",
"display",
"id",
"name",
"site_count",
"slug",
"url"
]
},
"BriefSiteGroupRequest": {
"type": "object",
"description": "Extends PrimaryModelSerializer to include MPTT support.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name",
"slug"
]
},
"BriefSiteRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"description": "Full name of the site",
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name",
"slug"
]
},
"BriefTag": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"pattern": "^[-\\w]+$",
"maxLength": 100
},
"color": {
"type": "string",
"pattern": "^[0-9a-f]{6}$",
"maxLength": 6
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"display",
"id",
"name",
"slug",
"url"
]
},
"BriefTenant": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"display",
"id",
"name",
"slug",
"url"
]
},
"BriefTenantGroup": {
"type": "object",
"description": "Extends PrimaryModelSerializer to include MPTT support.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
},
"tenant_count": {
"type": "integer",
"readOnly": true,
"default": 0
},
"_depth": {
"type": "integer",
"readOnly": true,
"title": " depth"
}
},
"required": [
"_depth",
"display",
"id",
"name",
"slug",
"tenant_count",
"url"
]
},
"BriefTenantGroupRequest": {
"type": "object",
"description": "Extends PrimaryModelSerializer to include MPTT support.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name",
"slug"
]
},
"BriefTenantRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name",
"slug"
]
},
"BriefTunnel": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"display",
"id",
"name",
"url"
]
},
"BriefTunnelGroup": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
},
"tunnel_count": {
"type": "integer",
"format": "int64",
"readOnly": true
}
},
"required": [
"display",
"id",
"name",
"slug",
"tunnel_count",
"url"
]
},
"BriefTunnelGroupRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name",
"slug"
]
},
"BriefTunnelRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name"
]
},
"BriefUser": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"username": {
"type": "string",
"description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
"pattern": "^[\\w.@+-]+$",
"maxLength": 150
}
},
"required": [
"display",
"id",
"url",
"username"
]
},
"BriefUserRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"username": {
"type": "string",
"minLength": 1,
"description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
"pattern": "^[\\w.@+-]+$",
"maxLength": 150
}
},
"required": [
"username"
]
},
"BriefVLAN": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"vid": {
"type": "integer",
"maximum": 4094,
"minimum": 1,
"title": "VLAN ID",
"description": "Numeric VLAN ID (1-4094)"
},
"name": {
"type": "string",
"maxLength": 64
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"display",
"id",
"name",
"url",
"vid"
]
},
"BriefVLANGroup": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
},
"vlan_count": {
"type": "integer",
"format": "int64",
"readOnly": true
}
},
"required": [
"display",
"id",
"name",
"slug",
"url",
"vlan_count"
]
},
"BriefVLANGroupRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name",
"slug"
]
},
"BriefVLANRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"vid": {
"type": "integer",
"maximum": 4094,
"minimum": 1,
"title": "VLAN ID",
"description": "Numeric VLAN ID (1-4094)"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name",
"vid"
]
},
"BriefVLANTranslationPolicy": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"display",
"id",
"name",
"url"
]
},
"BriefVLANTranslationPolicyRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name"
]
},
"BriefVRF": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"rd": {
"type": "string",
"nullable": true,
"title": "Route distinguisher",
"description": "Unique route distinguisher (as defined in RFC 4364)",
"maxLength": 21
},
"description": {
"type": "string",
"maxLength": 200
},
"prefix_count": {
"type": "integer",
"format": "int64",
"readOnly": true
}
},
"required": [
"display",
"id",
"name",
"prefix_count",
"url"
]
},
"BriefVRFRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"rd": {
"type": "string",
"nullable": true,
"title": "Route distinguisher",
"description": "Unique route distinguisher (as defined in RFC 4364)",
"maxLength": 21
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name"
]
},
"BriefVirtualChassis": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 64
},
"master": {
"allOf": [
{
"$ref": "#/components/schemas/NestedDevice"
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"member_count": {
"type": "integer",
"readOnly": true
}
},
"required": [
"display",
"id",
"member_count",
"name",
"url"
]
},
"BriefVirtualChassisRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"master": {
"allOf": [
{
"$ref": "#/components/schemas/NestedDeviceRequest"
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name"
]
},
"BriefVirtualCircuit": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"cid": {
"type": "string",
"title": "Circuit ID",
"description": "Unique circuit ID",
"maxLength": 100
},
"provider_network": {
"$ref": "#/components/schemas/BriefProviderNetwork"
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"cid",
"display",
"id",
"provider_network",
"url"
]
},
"BriefVirtualCircuitRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"cid": {
"type": "string",
"minLength": 1,
"title": "Circuit ID",
"description": "Unique circuit ID",
"maxLength": 100
},
"provider_network": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefProviderNetworkRequest"
}
]
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"cid",
"provider_network"
]
},
"BriefVirtualCircuitType": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
},
"virtual_circuit_count": {
"type": "integer",
"format": "int64",
"readOnly": true
}
},
"required": [
"display",
"id",
"name",
"slug",
"url",
"virtual_circuit_count"
]
},
"BriefVirtualCircuitTypeRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name",
"slug"
]
},
"BriefVirtualMachine": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 64
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"display",
"id",
"name",
"url"
]
},
"BriefVirtualMachineRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name"
]
},
"BriefWirelessLANGroup": {
"type": "object",
"description": "Extends PrimaryModelSerializer to include MPTT support.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
},
"wirelesslan_count": {
"type": "integer",
"readOnly": true,
"default": 0
},
"_depth": {
"type": "integer",
"readOnly": true,
"title": " depth"
}
},
"required": [
"_depth",
"display",
"id",
"name",
"slug",
"url",
"wirelesslan_count"
]
},
"BriefWirelessLANGroupRequest": {
"type": "object",
"description": "Extends PrimaryModelSerializer to include MPTT support.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name",
"slug"
]
},
"Cable": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"type": {
"enum": [
"cat3",
"cat5",
"cat5e",
"cat6",
"cat6a",
"cat7",
"cat7a",
"cat8",
"dac-active",
"dac-passive",
"mrj21-trunk",
"coaxial",
"mmf",
"mmf-om1",
"mmf-om2",
"mmf-om3",
"mmf-om4",
"mmf-om5",
"smf",
"smf-os1",
"smf-os2",
"aoc",
"usb",
"power",
"",
null
],
"type": "string",
"description": "* `cat3` - CAT3\n* `cat5` - CAT5\n* `cat5e` - CAT5e\n* `cat6` - CAT6\n* `cat6a` - CAT6a\n* `cat7` - CAT7\n* `cat7a` - CAT7a\n* `cat8` - CAT8\n* `dac-active` - Direct Attach Copper (Active)\n* `dac-passive` - Direct Attach Copper (Passive)\n* `mrj21-trunk` - MRJ21 Trunk\n* `coaxial` - Coaxial\n* `mmf` - Multimode Fiber\n* `mmf-om1` - Multimode Fiber (OM1)\n* `mmf-om2` - Multimode Fiber (OM2)\n* `mmf-om3` - Multimode Fiber (OM3)\n* `mmf-om4` - Multimode Fiber (OM4)\n* `mmf-om5` - Multimode Fiber (OM5)\n* `smf` - Singlemode Fiber\n* `smf-os1` - Singlemode Fiber (OS1)\n* `smf-os2` - Singlemode Fiber (OS2)\n* `aoc` - Active Optical Cabling (AOC)\n* `usb` - USB\n* `power` - Power",
"x-spec-enum-id": "7b11d524b2b1a7ef",
"nullable": true
},
"a_terminations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GenericObject"
}
},
"b_terminations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GenericObject"
}
},
"status": {
"type": "object",
"properties": {
"value": {
"enum": [
"connected",
"planned",
"decommissioning"
],
"type": "string",
"description": "* `connected` - Connected\n* `planned` - Planned\n* `decommissioning` - Decommissioning",
"x-spec-enum-id": "fbc2f302c08be50d"
},
"label": {
"type": "string",
"enum": [
"Connected",
"Planned",
"Decommissioning"
]
}
}
},
"tenant": {
"allOf": [
{
"$ref": "#/components/schemas/BriefTenant"
}
],
"nullable": true
},
"label": {
"type": "string",
"maxLength": 100
},
"color": {
"type": "string",
"pattern": "^[0-9a-f]{6}$",
"maxLength": 6
},
"length": {
"type": "number",
"format": "double",
"maximum": 1000000,
"minimum": -1000000,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true
},
"length_unit": {
"type": "object",
"properties": {
"value": {
"enum": [
"km",
"m",
"cm",
"mi",
"ft",
"in",
"",
null
],
"type": "string",
"description": "* `km` - Kilometers\n* `m` - Meters\n* `cm` - Centimeters\n* `mi` - Miles\n* `ft` - Feet\n* `in` - Inches",
"x-spec-enum-id": "e64ce3a2c5997172"
},
"label": {
"type": "string",
"enum": [
"Kilometers",
"Meters",
"Centimeters",
"Miles",
"Feet",
"Inches"
]
}
},
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"created",
"display",
"display_url",
"id",
"last_updated",
"url"
]
},
"CableRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"type": {
"enum": [
"cat3",
"cat5",
"cat5e",
"cat6",
"cat6a",
"cat7",
"cat7a",
"cat8",
"dac-active",
"dac-passive",
"mrj21-trunk",
"coaxial",
"mmf",
"mmf-om1",
"mmf-om2",
"mmf-om3",
"mmf-om4",
"mmf-om5",
"smf",
"smf-os1",
"smf-os2",
"aoc",
"usb",
"power",
"",
null
],
"type": "string",
"description": "* `cat3` - CAT3\n* `cat5` - CAT5\n* `cat5e` - CAT5e\n* `cat6` - CAT6\n* `cat6a` - CAT6a\n* `cat7` - CAT7\n* `cat7a` - CAT7a\n* `cat8` - CAT8\n* `dac-active` - Direct Attach Copper (Active)\n* `dac-passive` - Direct Attach Copper (Passive)\n* `mrj21-trunk` - MRJ21 Trunk\n* `coaxial` - Coaxial\n* `mmf` - Multimode Fiber\n* `mmf-om1` - Multimode Fiber (OM1)\n* `mmf-om2` - Multimode Fiber (OM2)\n* `mmf-om3` - Multimode Fiber (OM3)\n* `mmf-om4` - Multimode Fiber (OM4)\n* `mmf-om5` - Multimode Fiber (OM5)\n* `smf` - Singlemode Fiber\n* `smf-os1` - Singlemode Fiber (OS1)\n* `smf-os2` - Singlemode Fiber (OS2)\n* `aoc` - Active Optical Cabling (AOC)\n* `usb` - USB\n* `power` - Power",
"x-spec-enum-id": "7b11d524b2b1a7ef",
"nullable": true
},
"a_terminations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GenericObjectRequest"
}
},
"b_terminations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GenericObjectRequest"
}
},
"status": {
"enum": [
"connected",
"planned",
"decommissioning"
],
"type": "string",
"description": "* `connected` - Connected\n* `planned` - Planned\n* `decommissioning` - Decommissioning",
"x-spec-enum-id": "fbc2f302c08be50d"
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"label": {
"type": "string",
"maxLength": 100
},
"color": {
"type": "string",
"pattern": "^[0-9a-f]{6}$",
"maxLength": 6
},
"length": {
"type": "number",
"format": "double",
"maximum": 1000000,
"minimum": -1000000,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true
},
"length_unit": {
"enum": [
"km",
"m",
"cm",
"mi",
"ft",
"in",
"",
null
],
"type": "string",
"description": "* `km` - Kilometers\n* `m` - Meters\n* `cm` - Centimeters\n* `mi` - Miles\n* `ft` - Feet\n* `in` - Inches",
"x-spec-enum-id": "e64ce3a2c5997172",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"CableTermination": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"cable": {
"type": "integer"
},
"cable_end": {
"enum": [
"A",
"B"
],
"type": "string",
"description": "* `A` - A\n* `B` - B",
"x-spec-enum-id": "1db84f9b93b261c8",
"title": "End"
},
"termination_type": {
"type": "string"
},
"termination_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64"
},
"termination": {
"nullable": true,
"readOnly": true
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"cable",
"cable_end",
"created",
"display",
"id",
"last_updated",
"termination",
"termination_id",
"termination_type",
"url"
]
},
"CableTerminationRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"cable": {
"type": "integer"
},
"cable_end": {
"enum": [
"A",
"B"
],
"type": "string",
"description": "* `A` - A\n* `B` - B",
"x-spec-enum-id": "1db84f9b93b261c8",
"title": "End"
},
"termination_type": {
"type": "string"
},
"termination_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64"
}
},
"required": [
"cable",
"cable_end",
"termination_id",
"termination_type"
]
},
"Circuit": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"cid": {
"type": "string",
"title": "Circuit ID",
"description": "Unique circuit ID",
"maxLength": 100
},
"provider": {
"$ref": "#/components/schemas/BriefProvider"
},
"provider_account": {
"allOf": [
{
"$ref": "#/components/schemas/BriefProviderAccount"
}
],
"nullable": true
},
"type": {
"$ref": "#/components/schemas/BriefCircuitType"
},
"status": {
"type": "object",
"properties": {
"value": {
"enum": [
"planned",
"provisioning",
"active",
"offline",
"deprovisioning",
"decommissioned"
],
"type": "string",
"description": "* `planned` - Planned\n* `provisioning` - Provisioning\n* `active` - Active\n* `offline` - Offline\n* `deprovisioning` - Deprovisioning\n* `decommissioned` - Decommissioned",
"x-spec-enum-id": "63c838134a022200"
},
"label": {
"type": "string",
"enum": [
"Planned",
"Provisioning",
"Active",
"Offline",
"Deprovisioning",
"Decommissioned"
]
}
}
},
"tenant": {
"allOf": [
{
"$ref": "#/components/schemas/BriefTenant"
}
],
"nullable": true
},
"install_date": {
"type": "string",
"format": "date",
"nullable": true,
"title": "Installed"
},
"termination_date": {
"type": "string",
"format": "date",
"nullable": true,
"title": "Terminates"
},
"commit_rate": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"title": "Commit rate (Kbps)",
"description": "Committed rate"
},
"description": {
"type": "string",
"maxLength": 200
},
"distance": {
"type": "number",
"format": "double",
"maximum": 1000000,
"minimum": -1000000,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true
},
"distance_unit": {
"type": "object",
"properties": {
"value": {
"enum": [
"km",
"m",
"mi",
"ft",
"",
null
],
"type": "string",
"description": "* `km` - Kilometers\n* `m` - Meters\n* `mi` - Miles\n* `ft` - Feet",
"x-spec-enum-id": "53542e7902f946af"
},
"label": {
"type": "string",
"enum": [
"Kilometers",
"Meters",
"Miles",
"Feet"
]
}
},
"nullable": true
},
"termination_a": {
"allOf": [
{
"$ref": "#/components/schemas/CircuitCircuitTermination"
}
],
"readOnly": true,
"nullable": true
},
"termination_z": {
"allOf": [
{
"$ref": "#/components/schemas/CircuitCircuitTermination"
}
],
"readOnly": true,
"nullable": true
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"assignments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BriefCircuitGroupAssignmentSerializer_"
}
}
},
"required": [
"cid",
"created",
"display",
"display_url",
"id",
"last_updated",
"provider",
"termination_a",
"termination_z",
"type",
"url"
]
},
"CircuitCircuitTermination": {
"type": "object",
"description": "Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a\ndictionary of attributes which can be used to uniquely identify the related object. This class should be\nsubclassed to return a full representation of the related object on read.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"termination_type": {
"type": "string",
"nullable": true
},
"termination_id": {
"type": "integer",
"nullable": true
},
"termination": {
"nullable": true,
"readOnly": true
},
"port_speed": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"title": "Port speed (Kbps)",
"description": "Physical circuit speed"
},
"upstream_speed": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"title": "Upstream speed (Kbps)",
"description": "Upstream speed, if different from port speed"
},
"xconnect_id": {
"type": "string",
"title": "Cross-connect ID",
"description": "ID of the local cross-connect",
"maxLength": 50
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"display",
"display_url",
"id",
"termination",
"url"
]
},
"CircuitCircuitTerminationRequest": {
"type": "object",
"description": "Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a\ndictionary of attributes which can be used to uniquely identify the related object. This class should be\nsubclassed to return a full representation of the related object on read.",
"properties": {
"termination_type": {
"type": "string",
"nullable": true
},
"termination_id": {
"type": "integer",
"nullable": true
},
"port_speed": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"title": "Port speed (Kbps)",
"description": "Physical circuit speed"
},
"upstream_speed": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"title": "Upstream speed (Kbps)",
"description": "Upstream speed, if different from port speed"
},
"xconnect_id": {
"type": "string",
"title": "Cross-connect ID",
"description": "ID of the local cross-connect",
"maxLength": 50
},
"description": {
"type": "string",
"maxLength": 200
}
}
},
"CircuitGroup": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
},
"tenant": {
"allOf": [
{
"$ref": "#/components/schemas/BriefTenant"
}
],
"nullable": true
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"circuit_count": {
"type": "integer",
"format": "int64",
"readOnly": true
}
},
"required": [
"circuit_count",
"created",
"display",
"display_url",
"id",
"last_updated",
"name",
"slug",
"url"
]
},
"CircuitGroupAssignment": {
"type": "object",
"description": "Base serializer for group assignments under CircuitSerializer.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"group": {
"$ref": "#/components/schemas/BriefCircuitGroup"
},
"member_type": {
"type": "string"
},
"member_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64"
},
"member": {
"nullable": true,
"readOnly": true
},
"priority": {
"type": "object",
"properties": {
"value": {
"enum": [
"primary",
"secondary",
"tertiary",
"inactive",
""
],
"type": "string",
"description": "* `primary` - Primary\n* `secondary` - Secondary\n* `tertiary` - Tertiary\n* `inactive` - Inactive",
"x-spec-enum-id": "ef3a31644cec7524"
},
"label": {
"type": "string",
"enum": [
"Primary",
"Secondary",
"Tertiary",
"Inactive"
]
}
}
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"created",
"display",
"display_url",
"group",
"id",
"last_updated",
"member",
"member_id",
"member_type",
"url"
]
},
"CircuitGroupAssignmentRequest": {
"type": "object",
"description": "Base serializer for group assignments under CircuitSerializer.",
"properties": {
"group": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefCircuitGroupRequest"
}
]
},
"member_type": {
"type": "string"
},
"member_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64"
},
"priority": {
"enum": [
"primary",
"secondary",
"tertiary",
"inactive",
""
],
"type": "string",
"description": "* `primary` - Primary\n* `secondary` - Secondary\n* `tertiary` - Tertiary\n* `inactive` - Inactive",
"x-spec-enum-id": "ef3a31644cec7524"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
}
},
"required": [
"group",
"member_id",
"member_type"
]
},
"CircuitGroupRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name",
"slug"
]
},
"CircuitRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"cid": {
"type": "string",
"minLength": 1,
"title": "Circuit ID",
"description": "Unique circuit ID",
"maxLength": 100
},
"provider": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefProviderRequest"
}
]
},
"provider_account": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefProviderAccountRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"type": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefCircuitTypeRequest"
}
]
},
"status": {
"enum": [
"planned",
"provisioning",
"active",
"offline",
"deprovisioning",
"decommissioned"
],
"type": "string",
"description": "* `planned` - Planned\n* `provisioning` - Provisioning\n* `active` - Active\n* `offline` - Offline\n* `deprovisioning` - Deprovisioning\n* `decommissioned` - Decommissioned",
"x-spec-enum-id": "63c838134a022200"
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"install_date": {
"type": "string",
"format": "date",
"nullable": true,
"title": "Installed"
},
"termination_date": {
"type": "string",
"format": "date",
"nullable": true,
"title": "Terminates"
},
"commit_rate": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"title": "Commit rate (Kbps)",
"description": "Committed rate"
},
"description": {
"type": "string",
"maxLength": 200
},
"distance": {
"type": "number",
"format": "double",
"maximum": 1000000,
"minimum": -1000000,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true
},
"distance_unit": {
"enum": [
"km",
"m",
"mi",
"ft",
"",
null
],
"type": "string",
"description": "* `km` - Kilometers\n* `m` - Meters\n* `mi` - Miles\n* `ft` - Feet",
"x-spec-enum-id": "53542e7902f946af",
"nullable": true
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"assignments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BriefCircuitGroupAssignmentSerializer_Request"
}
}
},
"required": [
"cid",
"provider",
"type"
]
},
"CircuitTermination": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"circuit": {
"$ref": "#/components/schemas/BriefCircuit"
},
"term_side": {
"enum": [
"A",
"Z"
],
"type": "string",
"description": "* `A` - A\n* `Z` - Z",
"x-spec-enum-id": "95b8fcc737f355d0",
"title": "Termination side"
},
"termination_type": {
"type": "string",
"nullable": true
},
"termination_id": {
"type": "integer",
"nullable": true
},
"termination": {
"nullable": true,
"readOnly": true
},
"port_speed": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"title": "Port speed (Kbps)",
"description": "Physical circuit speed"
},
"upstream_speed": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"title": "Upstream speed (Kbps)",
"description": "Upstream speed, if different from port speed"
},
"xconnect_id": {
"type": "string",
"title": "Cross-connect ID",
"description": "ID of the local cross-connect",
"maxLength": 50
},
"pp_info": {
"type": "string",
"title": "Patch panel/port(s)",
"description": "Patch panel ID and port number(s)",
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"mark_connected": {
"type": "boolean",
"description": "Treat as if a cable is connected"
},
"cable": {
"allOf": [
{
"$ref": "#/components/schemas/BriefCable"
}
],
"readOnly": true,
"nullable": true
},
"cable_end": {
"type": "string",
"readOnly": true
},
"link_peers": {
"type": "array",
"items": {},
"readOnly": true
},
"link_peers_type": {
"type": "string",
"description": "Return the type of the peer link terminations, or None.",
"readOnly": true,
"nullable": true
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"_occupied": {
"type": "boolean",
"readOnly": true,
"title": " occupied"
}
},
"required": [
"_occupied",
"cable",
"cable_end",
"circuit",
"created",
"display",
"display_url",
"id",
"last_updated",
"link_peers",
"link_peers_type",
"term_side",
"termination",
"url"
]
},
"CircuitTerminationRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"circuit": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefCircuitRequest"
}
]
},
"term_side": {
"enum": [
"A",
"Z"
],
"type": "string",
"description": "* `A` - A\n* `Z` - Z",
"x-spec-enum-id": "95b8fcc737f355d0",
"title": "Termination side"
},
"termination_type": {
"type": "string",
"nullable": true
},
"termination_id": {
"type": "integer",
"nullable": true
},
"port_speed": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"title": "Port speed (Kbps)",
"description": "Physical circuit speed"
},
"upstream_speed": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"title": "Upstream speed (Kbps)",
"description": "Upstream speed, if different from port speed"
},
"xconnect_id": {
"type": "string",
"title": "Cross-connect ID",
"description": "ID of the local cross-connect",
"maxLength": 50
},
"pp_info": {
"type": "string",
"title": "Patch panel/port(s)",
"description": "Patch panel ID and port number(s)",
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"mark_connected": {
"type": "boolean",
"description": "Treat as if a cable is connected"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"circuit",
"term_side"
]
},
"CircuitType": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"color": {
"type": "string",
"pattern": "^[0-9a-f]{6}$",
"maxLength": 6
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"circuit_count": {
"type": "integer",
"format": "int64",
"readOnly": true
}
},
"required": [
"circuit_count",
"created",
"display",
"display_url",
"id",
"last_updated",
"name",
"slug",
"url"
]
},
"CircuitTypeRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"color": {
"type": "string",
"pattern": "^[0-9a-f]{6}$",
"maxLength": 6
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name",
"slug"
]
},
"Cluster": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"type": {
"$ref": "#/components/schemas/BriefClusterType"
},
"group": {
"allOf": [
{
"$ref": "#/components/schemas/BriefClusterGroup"
}
],
"nullable": true
},
"status": {
"type": "object",
"properties": {
"value": {
"enum": [
"planned",
"staging",
"active",
"decommissioning",
"offline"
],
"type": "string",
"description": "* `planned` - Planned\n* `staging` - Staging\n* `active` - Active\n* `decommissioning` - Decommissioning\n* `offline` - Offline",
"x-spec-enum-id": "79d20a734d0eecbb"
},
"label": {
"type": "string",
"enum": [
"Planned",
"Staging",
"Active",
"Decommissioning",
"Offline"
]
}
}
},
"tenant": {
"allOf": [
{
"$ref": "#/components/schemas/BriefTenant"
}
],
"nullable": true
},
"scope_type": {
"type": "string",
"nullable": true
},
"scope_id": {
"type": "integer",
"nullable": true
},
"scope": {
"nullable": true,
"readOnly": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"device_count": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"virtualmachine_count": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"allocated_vcpus": {
"type": "number",
"format": "double",
"maximum": 1000000,
"minimum": -1000000,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"readOnly": true
},
"allocated_memory": {
"type": "integer",
"readOnly": true
},
"allocated_disk": {
"type": "integer",
"readOnly": true
}
},
"required": [
"allocated_disk",
"allocated_memory",
"allocated_vcpus",
"created",
"device_count",
"display",
"display_url",
"id",
"last_updated",
"name",
"scope",
"type",
"url",
"virtualmachine_count"
]
},
"ClusterGroup": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"cluster_count": {
"type": "integer",
"format": "int64",
"readOnly": true
}
},
"required": [
"cluster_count",
"created",
"display",
"display_url",
"id",
"last_updated",
"name",
"slug",
"url"
]
},
"ClusterGroupRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name",
"slug"
]
},
"ClusterRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"type": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefClusterTypeRequest"
}
]
},
"group": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefClusterGroupRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"status": {
"enum": [
"planned",
"staging",
"active",
"decommissioning",
"offline"
],
"type": "string",
"description": "* `planned` - Planned\n* `staging` - Staging\n* `active` - Active\n* `decommissioning` - Decommissioning\n* `offline` - Offline",
"x-spec-enum-id": "79d20a734d0eecbb"
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"scope_type": {
"type": "string",
"nullable": true
},
"scope_id": {
"type": "integer",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name",
"type"
]
},
"ClusterType": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"cluster_count": {
"type": "integer",
"format": "int64",
"readOnly": true
}
},
"required": [
"cluster_count",
"created",
"display",
"display_url",
"id",
"last_updated",
"name",
"slug",
"url"
]
},
"ClusterTypeRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name",
"slug"
]
},
"ConfigContext": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"weight": {
"type": "integer",
"maximum": 32767,
"minimum": 0
},
"profile": {
"allOf": [
{
"$ref": "#/components/schemas/BriefConfigContextProfile"
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"is_active": {
"type": "boolean"
},
"regions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Region"
}
},
"site_groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SiteGroup"
}
},
"sites": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Site"
}
},
"locations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Location"
}
},
"device_types": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceType"
}
},
"roles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceRole"
}
},
"platforms": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Platform"
}
},
"cluster_types": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClusterType"
}
},
"cluster_groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClusterGroup"
}
},
"clusters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Cluster"
}
},
"tenant_groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TenantGroup"
}
},
"tenants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Tenant"
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"data_source": {
"$ref": "#/components/schemas/BriefDataSource"
},
"data_path": {
"type": "string",
"readOnly": true,
"description": "Path to remote file (relative to data source root)"
},
"data_file": {
"allOf": [
{
"$ref": "#/components/schemas/BriefDataFile"
}
],
"readOnly": true
},
"data_synced": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true,
"title": "Date synced"
},
"data": {},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"created",
"data",
"data_file",
"data_path",
"data_synced",
"display",
"display_url",
"id",
"last_updated",
"name",
"url"
]
},
"ConfigContextProfile": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"schema": {
"nullable": true,
"description": "A JSON schema specifying the structure of the context data for this profile"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"comments": {
"type": "string"
},
"data_source": {
"$ref": "#/components/schemas/BriefDataSource"
},
"data_path": {
"type": "string",
"readOnly": true,
"description": "Path to remote file (relative to data source root)"
},
"data_file": {
"allOf": [
{
"$ref": "#/components/schemas/BriefDataFile"
}
],
"readOnly": true
},
"data_synced": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true,
"title": "Date synced"
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"created",
"data_file",
"data_path",
"data_synced",
"display",
"display_url",
"id",
"last_updated",
"name",
"url"
]
},
"ConfigContextProfileRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"schema": {
"nullable": true,
"description": "A JSON schema specifying the structure of the context data for this profile"
},
"tags": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"comments": {
"type": "string"
},
"data_source": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDataSourceRequest"
}
]
}
},
"required": [
"name"
]
},
"ConfigContextRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"weight": {
"type": "integer",
"maximum": 32767,
"minimum": 0
},
"profile": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefConfigContextProfileRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"is_active": {
"type": "boolean"
},
"regions": {
"type": "array",
"items": {
"type": "integer"
}
},
"site_groups": {
"type": "array",
"items": {
"type": "integer"
}
},
"sites": {
"type": "array",
"items": {
"type": "integer"
}
},
"locations": {
"type": "array",
"items": {
"type": "integer"
}
},
"device_types": {
"type": "array",
"items": {
"type": "integer"
}
},
"roles": {
"type": "array",
"items": {
"type": "integer"
}
},
"platforms": {
"type": "array",
"items": {
"type": "integer"
}
},
"cluster_types": {
"type": "array",
"items": {
"type": "integer"
}
},
"cluster_groups": {
"type": "array",
"items": {
"type": "integer"
}
},
"clusters": {
"type": "array",
"items": {
"type": "integer"
}
},
"tenant_groups": {
"type": "array",
"items": {
"type": "integer"
}
},
"tenants": {
"type": "array",
"items": {
"type": "integer"
}
},
"tags": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"data_source": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDataSourceRequest"
}
]
},
"data": {}
},
"required": [
"data",
"name"
]
},
"ConfigTemplate": {
"type": "object",
"description": "Introduces support for Tag assignment. Adds `tags` serialization, and handles tag assignment\non create() and update().",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"environment_params": {
"nullable": true,
"title": "Environment parameters",
"description": "Any additional parameters to pass when constructing the Jinja environment"
},
"template_code": {
"type": "string",
"description": "Jinja template code."
},
"mime_type": {
"type": "string",
"description": "Defaults to text/plain; charset=utf-8",
"maxLength": 50
},
"file_name": {
"type": "string",
"description": "Filename to give to the rendered export file",
"maxLength": 200
},
"file_extension": {
"type": "string",
"description": "Extension to append to the rendered filename",
"maxLength": 15
},
"as_attachment": {
"type": "boolean",
"description": "Download file as attachment"
},
"data_source": {
"$ref": "#/components/schemas/BriefDataSource"
},
"data_path": {
"type": "string",
"readOnly": true,
"description": "Path to remote file (relative to data source root)"
},
"data_file": {
"$ref": "#/components/schemas/BriefDataFile"
},
"data_synced": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true,
"title": "Date synced"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"created",
"data_path",
"data_synced",
"display",
"display_url",
"id",
"last_updated",
"name",
"template_code",
"url"
]
},
"ConfigTemplateRequest": {
"type": "object",
"description": "Introduces support for Tag assignment. Adds `tags` serialization, and handles tag assignment\non create() and update().",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"environment_params": {
"nullable": true,
"title": "Environment parameters",
"description": "Any additional parameters to pass when constructing the Jinja environment"
},
"template_code": {
"type": "string",
"minLength": 1,
"description": "Jinja template code."
},
"mime_type": {
"type": "string",
"description": "Defaults to text/plain; charset=utf-8",
"maxLength": 50
},
"file_name": {
"type": "string",
"description": "Filename to give to the rendered export file",
"maxLength": 200
},
"file_extension": {
"type": "string",
"description": "Extension to append to the rendered filename",
"maxLength": 15
},
"as_attachment": {
"type": "boolean",
"description": "Download file as attachment"
},
"data_source": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDataSourceRequest"
}
]
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
}
},
"required": [
"name",
"template_code"
]
},
"ConsolePort": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"device": {
"$ref": "#/components/schemas/BriefDevice"
},
"module": {
"allOf": [
{
"$ref": "#/components/schemas/BriefModule"
}
],
"nullable": true
},
"name": {
"type": "string",
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"type": "object",
"properties": {
"value": {
"enum": [
"de-9",
"db-25",
"rj-11",
"rj-12",
"rj-45",
"mini-din-8",
"usb-a",
"usb-b",
"usb-c",
"usb-mini-a",
"usb-mini-b",
"usb-micro-a",
"usb-micro-b",
"usb-micro-ab",
"other",
""
],
"type": "string",
"description": "* `de-9` - DE-9\n* `db-25` - DB-25\n* `rj-11` - RJ-11\n* `rj-12` - RJ-12\n* `rj-45` - RJ-45\n* `mini-din-8` - Mini-DIN 8\n* `usb-a` - USB Type A\n* `usb-b` - USB Type B\n* `usb-c` - USB Type C\n* `usb-mini-a` - USB Mini A\n* `usb-mini-b` - USB Mini B\n* `usb-micro-a` - USB Micro A\n* `usb-micro-b` - USB Micro B\n* `usb-micro-ab` - USB Micro AB\n* `other` - Other",
"x-spec-enum-id": "c5f7197b7211818a"
},
"label": {
"type": "string",
"enum": [
"DE-9",
"DB-25",
"RJ-11",
"RJ-12",
"RJ-45",
"Mini-DIN 8",
"USB Type A",
"USB Type B",
"USB Type C",
"USB Mini A",
"USB Mini B",
"USB Micro A",
"USB Micro B",
"USB Micro AB",
"Other"
]
}
}
},
"speed": {
"type": "object",
"properties": {
"value": {
"enum": [
1200,
2400,
4800,
9600,
19200,
38400,
57600,
115200,
null
],
"type": "integer",
"description": "* `1200` - 1200 bps\n* `2400` - 2400 bps\n* `4800` - 4800 bps\n* `9600` - 9600 bps\n* `19200` - 19.2 kbps\n* `38400` - 38.4 kbps\n* `57600` - 57.6 kbps\n* `115200` - 115.2 kbps",
"x-spec-enum-id": "ab6d9635c131a378"
},
"label": {
"type": "string",
"enum": [
"1200 bps",
"2400 bps",
"4800 bps",
"9600 bps",
"19.2 kbps",
"38.4 kbps",
"57.6 kbps",
"115.2 kbps"
]
}
},
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"mark_connected": {
"type": "boolean",
"description": "Treat as if a cable is connected"
},
"cable": {
"allOf": [
{
"$ref": "#/components/schemas/BriefCable"
}
],
"readOnly": true,
"nullable": true
},
"cable_end": {
"type": "string",
"readOnly": true
},
"link_peers": {
"type": "array",
"items": {},
"readOnly": true
},
"link_peers_type": {
"type": "string",
"description": "Return the type of the peer link terminations, or None.",
"readOnly": true,
"nullable": true
},
"connected_endpoints": {
"type": "array",
"items": {},
"nullable": true,
"readOnly": true
},
"connected_endpoints_type": {
"type": "string",
"readOnly": true,
"nullable": true
},
"connected_endpoints_reachable": {
"type": "boolean",
"readOnly": true
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"_occupied": {
"type": "boolean",
"readOnly": true,
"title": " occupied"
}
},
"required": [
"_occupied",
"cable",
"cable_end",
"connected_endpoints",
"connected_endpoints_reachable",
"connected_endpoints_type",
"created",
"device",
"display",
"display_url",
"id",
"last_updated",
"link_peers",
"link_peers_type",
"name",
"url"
]
},
"ConsolePortRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"device": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDeviceRequest"
}
]
},
"module": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"enum": [
"de-9",
"db-25",
"rj-11",
"rj-12",
"rj-45",
"mini-din-8",
"usb-a",
"usb-b",
"usb-c",
"usb-mini-a",
"usb-mini-b",
"usb-micro-a",
"usb-micro-b",
"usb-micro-ab",
"other",
""
],
"type": "string",
"description": "* `de-9` - DE-9\n* `db-25` - DB-25\n* `rj-11` - RJ-11\n* `rj-12` - RJ-12\n* `rj-45` - RJ-45\n* `mini-din-8` - Mini-DIN 8\n* `usb-a` - USB Type A\n* `usb-b` - USB Type B\n* `usb-c` - USB Type C\n* `usb-mini-a` - USB Mini A\n* `usb-mini-b` - USB Mini B\n* `usb-micro-a` - USB Micro A\n* `usb-micro-b` - USB Micro B\n* `usb-micro-ab` - USB Micro AB\n* `other` - Other",
"x-spec-enum-id": "c5f7197b7211818a"
},
"speed": {
"enum": [
1200,
2400,
4800,
9600,
19200,
38400,
57600,
115200,
null
],
"type": "integer",
"description": "* `1200` - 1200 bps\n* `2400` - 2400 bps\n* `4800` - 4800 bps\n* `9600` - 9600 bps\n* `19200` - 19.2 kbps\n* `38400` - 38.4 kbps\n* `57600` - 57.6 kbps\n* `115200` - 115.2 kbps",
"x-spec-enum-id": "ab6d9635c131a378",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"mark_connected": {
"type": "boolean",
"description": "Treat as if a cable is connected"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"device",
"name"
]
},
"ConsolePortTemplate": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"device_type": {
"allOf": [
{
"$ref": "#/components/schemas/BriefDeviceType"
}
],
"nullable": true
},
"module_type": {
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleType"
}
],
"nullable": true
},
"name": {
"type": "string",
"description": "{module} is accepted as a substitution for the module bay position when attached to a module type.",
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"type": "object",
"properties": {
"value": {
"enum": [
"de-9",
"db-25",
"rj-11",
"rj-12",
"rj-45",
"mini-din-8",
"usb-a",
"usb-b",
"usb-c",
"usb-mini-a",
"usb-mini-b",
"usb-micro-a",
"usb-micro-b",
"usb-micro-ab",
"other",
""
],
"type": "string",
"description": "* `de-9` - DE-9\n* `db-25` - DB-25\n* `rj-11` - RJ-11\n* `rj-12` - RJ-12\n* `rj-45` - RJ-45\n* `mini-din-8` - Mini-DIN 8\n* `usb-a` - USB Type A\n* `usb-b` - USB Type B\n* `usb-c` - USB Type C\n* `usb-mini-a` - USB Mini A\n* `usb-mini-b` - USB Mini B\n* `usb-micro-a` - USB Micro A\n* `usb-micro-b` - USB Micro B\n* `usb-micro-ab` - USB Micro AB\n* `other` - Other",
"x-spec-enum-id": "c5f7197b7211818a"
},
"label": {
"type": "string",
"enum": [
"DE-9",
"DB-25",
"RJ-11",
"RJ-12",
"RJ-45",
"Mini-DIN 8",
"USB Type A",
"USB Type B",
"USB Type C",
"USB Mini A",
"USB Mini B",
"USB Micro A",
"USB Micro B",
"USB Micro AB",
"Other"
]
}
}
},
"description": {
"type": "string",
"maxLength": 200
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"created",
"display",
"id",
"last_updated",
"name",
"url"
]
},
"ConsolePortTemplateRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"device_type": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefDeviceTypeRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"module_type": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleTypeRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"description": "{module} is accepted as a substitution for the module bay position when attached to a module type.",
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"enum": [
"de-9",
"db-25",
"rj-11",
"rj-12",
"rj-45",
"mini-din-8",
"usb-a",
"usb-b",
"usb-c",
"usb-mini-a",
"usb-mini-b",
"usb-micro-a",
"usb-micro-b",
"usb-micro-ab",
"other",
""
],
"type": "string",
"description": "* `de-9` - DE-9\n* `db-25` - DB-25\n* `rj-11` - RJ-11\n* `rj-12` - RJ-12\n* `rj-45` - RJ-45\n* `mini-din-8` - Mini-DIN 8\n* `usb-a` - USB Type A\n* `usb-b` - USB Type B\n* `usb-c` - USB Type C\n* `usb-mini-a` - USB Mini A\n* `usb-mini-b` - USB Mini B\n* `usb-micro-a` - USB Micro A\n* `usb-micro-b` - USB Micro B\n* `usb-micro-ab` - USB Micro AB\n* `other` - Other",
"x-spec-enum-id": "c5f7197b7211818a"
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name"
]
},
"ConsoleServerPort": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"device": {
"$ref": "#/components/schemas/BriefDevice"
},
"module": {
"allOf": [
{
"$ref": "#/components/schemas/BriefModule"
}
],
"nullable": true
},
"name": {
"type": "string",
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"type": "object",
"properties": {
"value": {
"enum": [
"de-9",
"db-25",
"rj-11",
"rj-12",
"rj-45",
"mini-din-8",
"usb-a",
"usb-b",
"usb-c",
"usb-mini-a",
"usb-mini-b",
"usb-micro-a",
"usb-micro-b",
"usb-micro-ab",
"other",
""
],
"type": "string",
"description": "* `de-9` - DE-9\n* `db-25` - DB-25\n* `rj-11` - RJ-11\n* `rj-12` - RJ-12\n* `rj-45` - RJ-45\n* `mini-din-8` - Mini-DIN 8\n* `usb-a` - USB Type A\n* `usb-b` - USB Type B\n* `usb-c` - USB Type C\n* `usb-mini-a` - USB Mini A\n* `usb-mini-b` - USB Mini B\n* `usb-micro-a` - USB Micro A\n* `usb-micro-b` - USB Micro B\n* `usb-micro-ab` - USB Micro AB\n* `other` - Other",
"x-spec-enum-id": "c5f7197b7211818a"
},
"label": {
"type": "string",
"enum": [
"DE-9",
"DB-25",
"RJ-11",
"RJ-12",
"RJ-45",
"Mini-DIN 8",
"USB Type A",
"USB Type B",
"USB Type C",
"USB Mini A",
"USB Mini B",
"USB Micro A",
"USB Micro B",
"USB Micro AB",
"Other"
]
}
}
},
"speed": {
"type": "object",
"properties": {
"value": {
"enum": [
1200,
2400,
4800,
9600,
19200,
38400,
57600,
115200,
null
],
"type": "integer",
"description": "* `1200` - 1200 bps\n* `2400` - 2400 bps\n* `4800` - 4800 bps\n* `9600` - 9600 bps\n* `19200` - 19.2 kbps\n* `38400` - 38.4 kbps\n* `57600` - 57.6 kbps\n* `115200` - 115.2 kbps",
"x-spec-enum-id": "ab6d9635c131a378"
},
"label": {
"type": "string",
"enum": [
"1200 bps",
"2400 bps",
"4800 bps",
"9600 bps",
"19.2 kbps",
"38.4 kbps",
"57.6 kbps",
"115.2 kbps"
]
}
},
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"mark_connected": {
"type": "boolean",
"description": "Treat as if a cable is connected"
},
"cable": {
"allOf": [
{
"$ref": "#/components/schemas/BriefCable"
}
],
"readOnly": true,
"nullable": true
},
"cable_end": {
"type": "string",
"readOnly": true
},
"link_peers": {
"type": "array",
"items": {},
"readOnly": true
},
"link_peers_type": {
"type": "string",
"description": "Return the type of the peer link terminations, or None.",
"readOnly": true,
"nullable": true
},
"connected_endpoints": {
"type": "array",
"items": {},
"nullable": true,
"readOnly": true
},
"connected_endpoints_type": {
"type": "string",
"readOnly": true,
"nullable": true
},
"connected_endpoints_reachable": {
"type": "boolean",
"readOnly": true
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"_occupied": {
"type": "boolean",
"readOnly": true,
"title": " occupied"
}
},
"required": [
"_occupied",
"cable",
"cable_end",
"connected_endpoints",
"connected_endpoints_reachable",
"connected_endpoints_type",
"created",
"device",
"display",
"display_url",
"id",
"last_updated",
"link_peers",
"link_peers_type",
"name",
"url"
]
},
"ConsoleServerPortRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"device": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDeviceRequest"
}
]
},
"module": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"enum": [
"de-9",
"db-25",
"rj-11",
"rj-12",
"rj-45",
"mini-din-8",
"usb-a",
"usb-b",
"usb-c",
"usb-mini-a",
"usb-mini-b",
"usb-micro-a",
"usb-micro-b",
"usb-micro-ab",
"other",
""
],
"type": "string",
"description": "* `de-9` - DE-9\n* `db-25` - DB-25\n* `rj-11` - RJ-11\n* `rj-12` - RJ-12\n* `rj-45` - RJ-45\n* `mini-din-8` - Mini-DIN 8\n* `usb-a` - USB Type A\n* `usb-b` - USB Type B\n* `usb-c` - USB Type C\n* `usb-mini-a` - USB Mini A\n* `usb-mini-b` - USB Mini B\n* `usb-micro-a` - USB Micro A\n* `usb-micro-b` - USB Micro B\n* `usb-micro-ab` - USB Micro AB\n* `other` - Other",
"x-spec-enum-id": "c5f7197b7211818a"
},
"speed": {
"enum": [
1200,
2400,
4800,
9600,
19200,
38400,
57600,
115200,
null
],
"type": "integer",
"description": "* `1200` - 1200 bps\n* `2400` - 2400 bps\n* `4800` - 4800 bps\n* `9600` - 9600 bps\n* `19200` - 19.2 kbps\n* `38400` - 38.4 kbps\n* `57600` - 57.6 kbps\n* `115200` - 115.2 kbps",
"x-spec-enum-id": "ab6d9635c131a378",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"mark_connected": {
"type": "boolean",
"description": "Treat as if a cable is connected"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"device",
"name"
]
},
"ConsoleServerPortTemplate": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"device_type": {
"allOf": [
{
"$ref": "#/components/schemas/BriefDeviceType"
}
],
"nullable": true
},
"module_type": {
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleType"
}
],
"nullable": true
},
"name": {
"type": "string",
"description": "{module} is accepted as a substitution for the module bay position when attached to a module type.",
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"type": "object",
"properties": {
"value": {
"enum": [
"de-9",
"db-25",
"rj-11",
"rj-12",
"rj-45",
"mini-din-8",
"usb-a",
"usb-b",
"usb-c",
"usb-mini-a",
"usb-mini-b",
"usb-micro-a",
"usb-micro-b",
"usb-micro-ab",
"other",
""
],
"type": "string",
"description": "* `de-9` - DE-9\n* `db-25` - DB-25\n* `rj-11` - RJ-11\n* `rj-12` - RJ-12\n* `rj-45` - RJ-45\n* `mini-din-8` - Mini-DIN 8\n* `usb-a` - USB Type A\n* `usb-b` - USB Type B\n* `usb-c` - USB Type C\n* `usb-mini-a` - USB Mini A\n* `usb-mini-b` - USB Mini B\n* `usb-micro-a` - USB Micro A\n* `usb-micro-b` - USB Micro B\n* `usb-micro-ab` - USB Micro AB\n* `other` - Other",
"x-spec-enum-id": "c5f7197b7211818a"
},
"label": {
"type": "string",
"enum": [
"DE-9",
"DB-25",
"RJ-11",
"RJ-12",
"RJ-45",
"Mini-DIN 8",
"USB Type A",
"USB Type B",
"USB Type C",
"USB Mini A",
"USB Mini B",
"USB Micro A",
"USB Micro B",
"USB Micro AB",
"Other"
]
}
}
},
"description": {
"type": "string",
"maxLength": 200
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"created",
"display",
"id",
"last_updated",
"name",
"url"
]
},
"ConsoleServerPortTemplateRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"device_type": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefDeviceTypeRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"module_type": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleTypeRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"description": "{module} is accepted as a substitution for the module bay position when attached to a module type.",
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"enum": [
"de-9",
"db-25",
"rj-11",
"rj-12",
"rj-45",
"mini-din-8",
"usb-a",
"usb-b",
"usb-c",
"usb-mini-a",
"usb-mini-b",
"usb-micro-a",
"usb-micro-b",
"usb-micro-ab",
"other",
""
],
"type": "string",
"description": "* `de-9` - DE-9\n* `db-25` - DB-25\n* `rj-11` - RJ-11\n* `rj-12` - RJ-12\n* `rj-45` - RJ-45\n* `mini-din-8` - Mini-DIN 8\n* `usb-a` - USB Type A\n* `usb-b` - USB Type B\n* `usb-c` - USB Type C\n* `usb-mini-a` - USB Mini A\n* `usb-mini-b` - USB Mini B\n* `usb-micro-a` - USB Micro A\n* `usb-micro-b` - USB Micro B\n* `usb-micro-ab` - USB Micro AB\n* `other` - Other",
"x-spec-enum-id": "c5f7197b7211818a"
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name"
]
},
"Contact": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactGroup"
}
},
"name": {
"type": "string",
"maxLength": 100
},
"title": {
"type": "string",
"maxLength": 100
},
"phone": {
"type": "string",
"maxLength": 50
},
"email": {
"type": "string",
"format": "email",
"maxLength": 254
},
"address": {
"type": "string",
"maxLength": 200
},
"link": {
"type": "string",
"format": "uri",
"maxLength": 200
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"created",
"display",
"display_url",
"id",
"last_updated",
"name",
"url"
]
},
"ContactAssignment": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"object_type": {
"type": "string"
},
"object_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64"
},
"object": {
"type": "object",
"additionalProperties": {},
"readOnly": true
},
"contact": {
"$ref": "#/components/schemas/BriefContact"
},
"role": {
"allOf": [
{
"$ref": "#/components/schemas/BriefContactRole"
}
],
"nullable": true
},
"priority": {
"type": "object",
"properties": {
"value": {
"enum": [
"primary",
"secondary",
"tertiary",
"inactive",
""
],
"type": "string",
"description": "* `primary` - Primary\n* `secondary` - Secondary\n* `tertiary` - Tertiary\n* `inactive` - Inactive",
"x-spec-enum-id": "ef3a31644cec7524"
},
"label": {
"type": "string",
"enum": [
"Primary",
"Secondary",
"Tertiary",
"Inactive"
]
}
}
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"contact",
"created",
"display",
"id",
"last_updated",
"object",
"object_id",
"object_type",
"url"
]
},
"ContactAssignmentRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"object_type": {
"type": "string"
},
"object_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64"
},
"contact": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefContactRequest"
}
]
},
"role": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefContactRoleRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"priority": {
"enum": [
"primary",
"secondary",
"tertiary",
"inactive",
""
],
"type": "string",
"description": "* `primary` - Primary\n* `secondary` - Secondary\n* `tertiary` - Tertiary\n* `inactive` - Inactive",
"x-spec-enum-id": "ef3a31644cec7524"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"contact",
"object_id",
"object_type"
]
},
"ContactGroup": {
"type": "object",
"description": "Extends PrimaryModelSerializer to include MPTT support.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"parent": {
"allOf": [
{
"$ref": "#/components/schemas/NestedContactGroup"
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"contact_count": {
"type": "integer",
"readOnly": true,
"default": 0
},
"comments": {
"type": "string"
},
"_depth": {
"type": "integer",
"readOnly": true,
"title": " depth"
}
},
"required": [
"_depth",
"contact_count",
"created",
"display",
"display_url",
"id",
"last_updated",
"name",
"slug",
"url"
]
},
"ContactGroupRequest": {
"type": "object",
"description": "Extends PrimaryModelSerializer to include MPTT support.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"parent": {
"allOf": [
{
"$ref": "#/components/schemas/NestedContactGroupRequest"
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"comments": {
"type": "string"
}
},
"required": [
"name",
"slug"
]
},
"ContactRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"groups": {
"type": "array",
"items": {
"type": "integer"
}
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"title": {
"type": "string",
"maxLength": 100
},
"phone": {
"type": "string",
"maxLength": 50
},
"email": {
"type": "string",
"format": "email",
"maxLength": 254
},
"address": {
"type": "string",
"maxLength": 200
},
"link": {
"type": "string",
"format": "uri",
"maxLength": 200
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name"
]
},
"ContactRole": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"created",
"display",
"display_url",
"id",
"last_updated",
"name",
"slug",
"url"
]
},
"ContactRoleRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name",
"slug"
]
},
"CustomField": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"object_types": {
"type": "array",
"items": {
"type": "string"
}
},
"type": {
"type": "object",
"properties": {
"value": {
"enum": [
"text",
"longtext",
"integer",
"decimal",
"boolean",
"date",
"datetime",
"url",
"json",
"select",
"multiselect",
"object",
"multiobject"
],
"type": "string",
"description": "* `text` - Text\n* `longtext` - Text (long)\n* `integer` - Integer\n* `decimal` - Decimal\n* `boolean` - Boolean (true/false)\n* `date` - Date\n* `datetime` - Date & time\n* `url` - URL\n* `json` - JSON\n* `select` - Selection\n* `multiselect` - Multiple selection\n* `object` - Object\n* `multiobject` - Multiple objects",
"x-spec-enum-id": "22e3a64138d10046"
},
"label": {
"type": "string",
"enum": [
"Text",
"Text (long)",
"Integer",
"Decimal",
"Boolean (true/false)",
"Date",
"Date & time",
"URL",
"JSON",
"Selection",
"Multiple selection",
"Object",
"Multiple objects"
]
}
}
},
"related_object_type": {
"type": "string",
"nullable": true
},
"data_type": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"description": "Internal field name",
"pattern": "^[a-z0-9_]+$",
"maxLength": 50
},
"label": {
"type": "string",
"description": "Name of the field as displayed to users (if not provided, 'the field's name will be used)",
"maxLength": 50
},
"group_name": {
"type": "string",
"description": "Custom fields within the same group will be displayed together",
"maxLength": 50
},
"description": {
"type": "string",
"maxLength": 200
},
"required": {
"type": "boolean",
"description": "This field is required when creating new objects or editing an existing object."
},
"unique": {
"type": "boolean",
"title": "Must be unique",
"description": "The value of this field must be unique for the assigned object"
},
"search_weight": {
"type": "integer",
"maximum": 32767,
"minimum": 0,
"description": "Weighting for search. Lower values are considered more important. Fields with a search weight of zero will be ignored."
},
"filter_logic": {
"type": "object",
"properties": {
"value": {
"enum": [
"disabled",
"loose",
"exact"
],
"type": "string",
"description": "* `disabled` - Disabled\n* `loose` - Loose\n* `exact` - Exact",
"x-spec-enum-id": "a958350ae21c10ee"
},
"label": {
"type": "string",
"enum": [
"Disabled",
"Loose",
"Exact"
]
}
}
},
"ui_visible": {
"type": "object",
"properties": {
"value": {
"enum": [
"always",
"if-set",
"hidden"
],
"type": "string",
"description": "* `always` - Always\n* `if-set` - If set\n* `hidden` - Hidden",
"x-spec-enum-id": "cd2cf94af56de747"
},
"label": {
"type": "string",
"enum": [
"Always",
"If set",
"Hidden"
]
}
}
},
"ui_editable": {
"type": "object",
"properties": {
"value": {
"enum": [
"yes",
"no",
"hidden"
],
"type": "string",
"description": "* `yes` - Yes\n* `no` - No\n* `hidden` - Hidden",
"x-spec-enum-id": "1065673147e26bb5"
},
"label": {
"type": "string",
"enum": [
"Yes",
"No",
"Hidden"
]
}
}
},
"is_cloneable": {
"type": "boolean",
"description": "Replicate this value when cloning objects"
},
"default": {
"nullable": true,
"description": "Default value for the field (must be a JSON value). Encapsulate strings with double quotes (e.g. \"Foo\")."
},
"related_object_filter": {
"nullable": true,
"description": "Filter the object selection choices using a query_params dict (must be a JSON value).Encapsulate strings with double quotes (e.g. \"Foo\")."
},
"weight": {
"type": "integer",
"maximum": 32767,
"minimum": 0,
"title": "Display weight",
"description": "Fields with higher weights appear lower in a form."
},
"validation_minimum": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"format": "int64",
"nullable": true,
"title": "Minimum value",
"description": "Minimum allowed value (for numeric fields)"
},
"validation_maximum": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"format": "int64",
"nullable": true,
"title": "Maximum value",
"description": "Maximum allowed value (for numeric fields)"
},
"validation_regex": {
"type": "string",
"description": "Regular expression to enforce on text field values. Use ^ and $ to force matching of entire string. For example, ^[A-Z]{3}$ will limit values to exactly three uppercase letters.",
"maxLength": 500
},
"choice_set": {
"allOf": [
{
"$ref": "#/components/schemas/BriefCustomFieldChoiceSet"
}
],
"nullable": true
},
"comments": {
"type": "string"
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"created",
"data_type",
"display",
"display_url",
"id",
"last_updated",
"name",
"object_types",
"type",
"url"
]
},
"CustomFieldChoiceSet": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"base_choices": {
"type": "object",
"properties": {
"value": {
"enum": [
"IATA",
"ISO_3166",
"UN_LOCODE"
],
"type": "string",
"description": "* `IATA` - IATA (Airport codes)\n* `ISO_3166` - ISO 3166 (Country codes)\n* `UN_LOCODE` - UN/LOCODE (Location codes)",
"x-spec-enum-id": "cf0efb5195f85007"
},
"label": {
"type": "string",
"enum": [
"IATA (Airport codes)",
"ISO 3166 (Country codes)",
"UN/LOCODE (Location codes)"
]
}
}
},
"extra_choices": {
"type": "array",
"items": {
"type": "array",
"items": {},
"maxItems": 2,
"minItems": 2
}
},
"order_alphabetically": {
"type": "boolean",
"description": "Choices are automatically ordered alphabetically"
},
"choices_count": {
"type": "string",
"readOnly": true
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"choices_count",
"created",
"display",
"display_url",
"extra_choices",
"id",
"last_updated",
"name",
"url"
]
},
"CustomFieldChoiceSetRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"base_choices": {
"enum": [
"IATA",
"ISO_3166",
"UN_LOCODE"
],
"type": "string",
"description": "* `IATA` - IATA (Airport codes)\n* `ISO_3166` - ISO 3166 (Country codes)\n* `UN_LOCODE` - UN/LOCODE (Location codes)",
"x-spec-enum-id": "cf0efb5195f85007"
},
"extra_choices": {
"type": "array",
"items": {
"type": "array",
"items": {},
"maxItems": 2,
"minItems": 2
}
},
"order_alphabetically": {
"type": "boolean",
"description": "Choices are automatically ordered alphabetically"
}
},
"required": [
"extra_choices",
"name"
]
},
"CustomFieldRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"object_types": {
"type": "array",
"items": {
"type": "string"
}
},
"type": {
"enum": [
"text",
"longtext",
"integer",
"decimal",
"boolean",
"date",
"datetime",
"url",
"json",
"select",
"multiselect",
"object",
"multiobject"
],
"type": "string",
"description": "* `text` - Text\n* `longtext` - Text (long)\n* `integer` - Integer\n* `decimal` - Decimal\n* `boolean` - Boolean (true/false)\n* `date` - Date\n* `datetime` - Date & time\n* `url` - URL\n* `json` - JSON\n* `select` - Selection\n* `multiselect` - Multiple selection\n* `object` - Object\n* `multiobject` - Multiple objects",
"x-spec-enum-id": "22e3a64138d10046"
},
"related_object_type": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"description": "Internal field name",
"pattern": "^[a-z0-9_]+$",
"maxLength": 50
},
"label": {
"type": "string",
"description": "Name of the field as displayed to users (if not provided, 'the field's name will be used)",
"maxLength": 50
},
"group_name": {
"type": "string",
"description": "Custom fields within the same group will be displayed together",
"maxLength": 50
},
"description": {
"type": "string",
"maxLength": 200
},
"required": {
"type": "boolean",
"description": "This field is required when creating new objects or editing an existing object."
},
"unique": {
"type": "boolean",
"title": "Must be unique",
"description": "The value of this field must be unique for the assigned object"
},
"search_weight": {
"type": "integer",
"maximum": 32767,
"minimum": 0,
"description": "Weighting for search. Lower values are considered more important. Fields with a search weight of zero will be ignored."
},
"filter_logic": {
"enum": [
"disabled",
"loose",
"exact"
],
"type": "string",
"description": "* `disabled` - Disabled\n* `loose` - Loose\n* `exact` - Exact",
"x-spec-enum-id": "a958350ae21c10ee"
},
"ui_visible": {
"enum": [
"always",
"if-set",
"hidden"
],
"type": "string",
"description": "* `always` - Always\n* `if-set` - If set\n* `hidden` - Hidden",
"x-spec-enum-id": "cd2cf94af56de747"
},
"ui_editable": {
"enum": [
"yes",
"no",
"hidden"
],
"type": "string",
"description": "* `yes` - Yes\n* `no` - No\n* `hidden` - Hidden",
"x-spec-enum-id": "1065673147e26bb5"
},
"is_cloneable": {
"type": "boolean",
"description": "Replicate this value when cloning objects"
},
"default": {
"nullable": true,
"description": "Default value for the field (must be a JSON value). Encapsulate strings with double quotes (e.g. \"Foo\")."
},
"related_object_filter": {
"nullable": true,
"description": "Filter the object selection choices using a query_params dict (must be a JSON value).Encapsulate strings with double quotes (e.g. \"Foo\")."
},
"weight": {
"type": "integer",
"maximum": 32767,
"minimum": 0,
"title": "Display weight",
"description": "Fields with higher weights appear lower in a form."
},
"validation_minimum": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"format": "int64",
"nullable": true,
"title": "Minimum value",
"description": "Minimum allowed value (for numeric fields)"
},
"validation_maximum": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"format": "int64",
"nullable": true,
"title": "Maximum value",
"description": "Maximum allowed value (for numeric fields)"
},
"validation_regex": {
"type": "string",
"description": "Regular expression to enforce on text field values. Use ^ and $ to force matching of entire string. For example, ^[A-Z]{3}$ will limit values to exactly three uppercase letters.",
"maxLength": 500
},
"choice_set": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefCustomFieldChoiceSetRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"comments": {
"type": "string"
}
},
"required": [
"name",
"object_types",
"type"
]
},
"CustomLink": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"object_types": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string",
"maxLength": 100
},
"enabled": {
"type": "boolean"
},
"link_text": {
"type": "string",
"description": "Jinja2 template code for link text"
},
"link_url": {
"type": "string",
"description": "Jinja2 template code for link URL"
},
"weight": {
"type": "integer",
"maximum": 32767,
"minimum": 0
},
"group_name": {
"type": "string",
"description": "Links with the same group will appear as a dropdown menu",
"maxLength": 50
},
"button_class": {
"enum": [
"default",
"blue",
"indigo",
"purple",
"pink",
"red",
"orange",
"yellow",
"green",
"teal",
"cyan",
"gray",
"black",
"white",
"ghost-dark"
],
"type": "string",
"x-spec-enum-id": "ee8e5bb1ccdcdb19",
"description": "The class of the first link in a group will be used for the dropdown button\n\n* `default` - Default\n* `blue` - Blue\n* `indigo` - Indigo\n* `purple` - Purple\n* `pink` - Pink\n* `red` - Red\n* `orange` - Orange\n* `yellow` - Yellow\n* `green` - Green\n* `teal` - Teal\n* `cyan` - Cyan\n* `gray` - Gray\n* `black` - Black\n* `white` - White\n* `ghost-dark` - Link"
},
"new_window": {
"type": "boolean",
"description": "Force link to open in a new window"
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"created",
"display",
"display_url",
"id",
"last_updated",
"link_text",
"link_url",
"name",
"object_types",
"url"
]
},
"CustomLinkRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"object_types": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"enabled": {
"type": "boolean"
},
"link_text": {
"type": "string",
"minLength": 1,
"description": "Jinja2 template code for link text"
},
"link_url": {
"type": "string",
"minLength": 1,
"description": "Jinja2 template code for link URL"
},
"weight": {
"type": "integer",
"maximum": 32767,
"minimum": 0
},
"group_name": {
"type": "string",
"description": "Links with the same group will appear as a dropdown menu",
"maxLength": 50
},
"button_class": {
"enum": [
"default",
"blue",
"indigo",
"purple",
"pink",
"red",
"orange",
"yellow",
"green",
"teal",
"cyan",
"gray",
"black",
"white",
"ghost-dark"
],
"type": "string",
"x-spec-enum-id": "ee8e5bb1ccdcdb19",
"description": "The class of the first link in a group will be used for the dropdown button\n\n* `default` - Default\n* `blue` - Blue\n* `indigo` - Indigo\n* `purple` - Purple\n* `pink` - Pink\n* `red` - Red\n* `orange` - Orange\n* `yellow` - Yellow\n* `green` - Green\n* `teal` - Teal\n* `cyan` - Cyan\n* `gray` - Gray\n* `black` - Black\n* `white` - White\n* `ghost-dark` - Link"
},
"new_window": {
"type": "boolean",
"description": "Force link to open in a new window"
}
},
"required": [
"link_text",
"link_url",
"name",
"object_types"
]
},
"Dashboard": {
"type": "object",
"properties": {
"layout": {},
"config": {}
}
},
"DashboardRequest": {
"type": "object",
"properties": {
"layout": {},
"config": {}
}
},
"DataFile": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"source": {
"allOf": [
{
"$ref": "#/components/schemas/BriefDataSource"
}
],
"readOnly": true
},
"path": {
"type": "string",
"readOnly": true,
"description": "File path relative to the data source's root"
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"size": {
"type": "integer",
"readOnly": true
},
"hash": {
"type": "string",
"readOnly": true,
"description": "SHA256 hash of the file data"
}
},
"required": [
"display",
"display_url",
"hash",
"id",
"last_updated",
"path",
"size",
"source",
"url"
]
},
"DataSource": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"type": {
"type": "object",
"properties": {
"value": {
"enum": [
null,
"local",
"git",
"amazon-s3"
],
"description": "* `None` - ---------\n* `local` - Local\n* `git` - Git\n* `amazon-s3` - Amazon S3",
"x-spec-enum-id": "570db3f2d4e98ccf"
},
"label": {
"type": "string",
"enum": [
"---------",
"Local",
"Git",
"Amazon S3"
]
}
}
},
"source_url": {
"type": "string",
"title": "URL",
"maxLength": 200
},
"enabled": {
"type": "boolean"
},
"status": {
"type": "object",
"properties": {
"value": {
"enum": [
"new",
"queued",
"syncing",
"completed",
"failed"
],
"type": "string",
"description": "* `new` - New\n* `queued` - Queued\n* `syncing` - Syncing\n* `completed` - Completed\n* `failed` - Failed",
"x-spec-enum-id": "6dfb2220617590c8"
},
"label": {
"type": "string",
"enum": [
"New",
"Queued",
"Syncing",
"Completed",
"Failed"
]
}
},
"readOnly": true
},
"description": {
"type": "string",
"maxLength": 200
},
"sync_interval": {
"enum": [
1,
60,
720,
1440,
10080,
43200,
null
],
"type": "integer",
"description": "* `1` - Minutely\n* `60` - Hourly\n* `720` - 12 hours\n* `1440` - Daily\n* `10080` - Weekly\n* `43200` - 30 days",
"x-spec-enum-id": "2e9f2567ecd93fbe",
"nullable": true,
"minimum": 0,
"maximum": 32767
},
"parameters": {
"nullable": true
},
"ignore_rules": {
"type": "string",
"description": "Patterns (one per line) matching files to ignore when syncing"
},
"comments": {
"type": "string"
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_synced": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"file_count": {
"type": "integer",
"format": "int64",
"readOnly": true
}
},
"required": [
"created",
"display",
"display_url",
"file_count",
"id",
"last_synced",
"last_updated",
"name",
"source_url",
"status",
"type",
"url"
]
},
"DataSourceRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"type": {
"enum": [
null,
"local",
"git",
"amazon-s3"
],
"description": "* `None` - ---------\n* `local` - Local\n* `git` - Git\n* `amazon-s3` - Amazon S3",
"x-spec-enum-id": "570db3f2d4e98ccf"
},
"source_url": {
"type": "string",
"minLength": 1,
"title": "URL",
"maxLength": 200
},
"enabled": {
"type": "boolean"
},
"description": {
"type": "string",
"maxLength": 200
},
"sync_interval": {
"enum": [
1,
60,
720,
1440,
10080,
43200,
null
],
"type": "integer",
"description": "* `1` - Minutely\n* `60` - Hourly\n* `720` - 12 hours\n* `1440` - Daily\n* `10080` - Weekly\n* `43200` - 30 days",
"x-spec-enum-id": "2e9f2567ecd93fbe",
"nullable": true,
"minimum": 0,
"maximum": 32767
},
"parameters": {
"nullable": true
},
"ignore_rules": {
"type": "string",
"description": "Patterns (one per line) matching files to ignore when syncing"
},
"comments": {
"type": "string"
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name",
"source_url",
"type"
]
},
"Device": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"nullable": true,
"maxLength": 64
},
"device_type": {
"$ref": "#/components/schemas/BriefDeviceType"
},
"role": {
"$ref": "#/components/schemas/BriefDeviceRole"
},
"tenant": {
"allOf": [
{
"$ref": "#/components/schemas/BriefTenant"
}
],
"nullable": true
},
"platform": {
"allOf": [
{
"$ref": "#/components/schemas/BriefPlatform"
}
],
"nullable": true
},
"serial": {
"type": "string",
"title": "Serial number",
"description": "Chassis serial number, assigned by the manufacturer",
"maxLength": 50
},
"asset_tag": {
"type": "string",
"nullable": true,
"description": "A unique tag used to identify this device",
"maxLength": 50
},
"site": {
"$ref": "#/components/schemas/BriefSite"
},
"location": {
"allOf": [
{
"$ref": "#/components/schemas/BriefLocation"
}
],
"nullable": true
},
"rack": {
"allOf": [
{
"$ref": "#/components/schemas/BriefRack"
}
],
"nullable": true
},
"position": {
"type": "number",
"format": "double",
"maximum": 1000,
"minimum": 0.5,
"exclusiveMaximum": true,
"nullable": true,
"title": "Position (U)"
},
"face": {
"type": "object",
"properties": {
"value": {
"enum": [
"front",
"rear",
""
],
"type": "string",
"description": "* `front` - Front\n* `rear` - Rear",
"x-spec-enum-id": "d2fb9b3f75158b83"
},
"label": {
"type": "string",
"enum": [
"Front",
"Rear"
]
}
}
},
"latitude": {
"type": "number",
"format": "double",
"maximum": 100,
"minimum": -100,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true,
"description": "GPS coordinate in decimal format (xx.yyyyyy)"
},
"longitude": {
"type": "number",
"format": "double",
"maximum": 1000,
"minimum": -1000,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true,
"description": "GPS coordinate in decimal format (xx.yyyyyy)"
},
"parent_device": {
"allOf": [
{
"$ref": "#/components/schemas/NestedDevice"
}
],
"nullable": true,
"readOnly": true
},
"status": {
"type": "object",
"properties": {
"value": {
"enum": [
"offline",
"active",
"planned",
"staged",
"failed",
"inventory",
"decommissioning"
],
"type": "string",
"description": "* `offline` - Offline\n* `active` - Active\n* `planned` - Planned\n* `staged` - Staged\n* `failed` - Failed\n* `inventory` - Inventory\n* `decommissioning` - Decommissioning",
"x-spec-enum-id": "8d8971779f16ee18"
},
"label": {
"type": "string",
"enum": [
"Offline",
"Active",
"Planned",
"Staged",
"Failed",
"Inventory",
"Decommissioning"
]
}
}
},
"airflow": {
"type": "object",
"properties": {
"value": {
"enum": [
"front-to-rear",
"rear-to-front",
"left-to-right",
"right-to-left",
"side-to-rear",
"rear-to-side",
"bottom-to-top",
"top-to-bottom",
"passive",
"mixed",
""
],
"type": "string",
"description": "* `front-to-rear` - Front to rear\n* `rear-to-front` - Rear to front\n* `left-to-right` - Left to right\n* `right-to-left` - Right to left\n* `side-to-rear` - Side to rear\n* `rear-to-side` - Rear to side\n* `bottom-to-top` - Bottom to top\n* `top-to-bottom` - Top to bottom\n* `passive` - Passive\n* `mixed` - Mixed",
"x-spec-enum-id": "943288113dad6782"
},
"label": {
"type": "string",
"enum": [
"Front to rear",
"Rear to front",
"Left to right",
"Right to left",
"Side to rear",
"Rear to side",
"Bottom to top",
"Top to bottom",
"Passive",
"Mixed"
]
}
}
},
"primary_ip": {
"allOf": [
{
"$ref": "#/components/schemas/BriefIPAddress"
}
],
"readOnly": true,
"nullable": true
},
"primary_ip4": {
"allOf": [
{
"$ref": "#/components/schemas/BriefIPAddress"
}
],
"nullable": true
},
"primary_ip6": {
"allOf": [
{
"$ref": "#/components/schemas/BriefIPAddress"
}
],
"nullable": true
},
"oob_ip": {
"allOf": [
{
"$ref": "#/components/schemas/BriefIPAddress"
}
],
"nullable": true
},
"cluster": {
"allOf": [
{
"$ref": "#/components/schemas/BriefCluster"
}
],
"nullable": true
},
"virtual_chassis": {
"allOf": [
{
"$ref": "#/components/schemas/BriefVirtualChassis"
}
],
"nullable": true
},
"vc_position": {
"type": "integer",
"maximum": 255,
"minimum": 0,
"nullable": true
},
"vc_priority": {
"type": "integer",
"maximum": 255,
"minimum": 0,
"nullable": true,
"description": "Virtual chassis master election priority"
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"config_template": {
"allOf": [
{
"$ref": "#/components/schemas/BriefConfigTemplate"
}
],
"nullable": true
},
"local_context_data": {
"nullable": true,
"description": "Local config context data takes precedence over source contexts in the final rendered config context"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"console_port_count": {
"type": "integer",
"readOnly": true
},
"console_server_port_count": {
"type": "integer",
"readOnly": true
},
"power_port_count": {
"type": "integer",
"readOnly": true
},
"power_outlet_count": {
"type": "integer",
"readOnly": true
},
"interface_count": {
"type": "integer",
"readOnly": true
},
"front_port_count": {
"type": "integer",
"readOnly": true
},
"rear_port_count": {
"type": "integer",
"readOnly": true
},
"device_bay_count": {
"type": "integer",
"readOnly": true
},
"module_bay_count": {
"type": "integer",
"readOnly": true
},
"inventory_item_count": {
"type": "integer",
"readOnly": true
}
},
"required": [
"console_port_count",
"console_server_port_count",
"created",
"device_bay_count",
"device_type",
"display",
"display_url",
"front_port_count",
"id",
"interface_count",
"inventory_item_count",
"last_updated",
"module_bay_count",
"parent_device",
"power_outlet_count",
"power_port_count",
"primary_ip",
"rear_port_count",
"role",
"site",
"url"
]
},
"DeviceBay": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"device": {
"$ref": "#/components/schemas/BriefDevice"
},
"name": {
"type": "string",
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"description": {
"type": "string",
"maxLength": 200
},
"installed_device": {
"allOf": [
{
"$ref": "#/components/schemas/BriefDevice"
}
],
"nullable": true
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"created",
"device",
"display",
"display_url",
"id",
"last_updated",
"name",
"url"
]
},
"DeviceBayRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"device": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDeviceRequest"
}
]
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"description": {
"type": "string",
"maxLength": 200
},
"installed_device": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefDeviceRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"device",
"name"
]
},
"DeviceBayTemplate": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"device_type": {
"$ref": "#/components/schemas/BriefDeviceType"
},
"name": {
"type": "string",
"description": "{module} is accepted as a substitution for the module bay position when attached to a module type.",
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"description": {
"type": "string",
"maxLength": 200
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"created",
"device_type",
"display",
"id",
"last_updated",
"name",
"url"
]
},
"DeviceBayTemplateRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"device_type": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDeviceTypeRequest"
}
]
},
"name": {
"type": "string",
"minLength": 1,
"description": "{module} is accepted as a substitution for the module bay position when attached to a module type.",
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"device_type",
"name"
]
},
"DeviceRole": {
"type": "object",
"description": "Extends PrimaryModelSerializer to include MPTT support.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"color": {
"type": "string",
"pattern": "^[0-9a-f]{6}$",
"maxLength": 6
},
"vm_role": {
"type": "boolean",
"description": "Virtual machines may be assigned to this role"
},
"config_template": {
"allOf": [
{
"$ref": "#/components/schemas/BriefConfigTemplate"
}
],
"nullable": true
},
"parent": {
"allOf": [
{
"$ref": "#/components/schemas/NestedDeviceRole"
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"device_count": {
"type": "integer",
"readOnly": true,
"default": 0
},
"virtualmachine_count": {
"type": "integer",
"readOnly": true,
"default": 0
},
"comments": {
"type": "string"
},
"_depth": {
"type": "integer",
"readOnly": true,
"title": " depth"
}
},
"required": [
"_depth",
"created",
"device_count",
"display",
"display_url",
"id",
"last_updated",
"name",
"slug",
"url",
"virtualmachine_count"
]
},
"DeviceRoleRequest": {
"type": "object",
"description": "Extends PrimaryModelSerializer to include MPTT support.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"color": {
"type": "string",
"minLength": 1,
"pattern": "^[0-9a-f]{6}$",
"maxLength": 6
},
"vm_role": {
"type": "boolean",
"description": "Virtual machines may be assigned to this role"
},
"config_template": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefConfigTemplateRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"parent": {
"allOf": [
{
"$ref": "#/components/schemas/NestedDeviceRoleRequest"
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"comments": {
"type": "string"
}
},
"required": [
"name",
"slug"
]
},
"DeviceType": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"manufacturer": {
"$ref": "#/components/schemas/BriefManufacturer"
},
"default_platform": {
"allOf": [
{
"$ref": "#/components/schemas/BriefPlatform"
}
],
"nullable": true
},
"model": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"part_number": {
"type": "string",
"description": "Discrete part number (optional)",
"maxLength": 50
},
"u_height": {
"type": "number",
"format": "double",
"maximum": 1000,
"minimum": 0.0,
"exclusiveMaximum": true,
"default": 1.0,
"title": "Position (U)"
},
"exclude_from_utilization": {
"type": "boolean",
"description": "Devices of this type are excluded when calculating rack utilization."
},
"is_full_depth": {
"type": "boolean",
"description": "Device consumes both front and rear rack faces."
},
"subdevice_role": {
"type": "object",
"properties": {
"value": {
"enum": [
"parent",
"child",
"",
null
],
"type": "string",
"description": "* `parent` - Parent\n* `child` - Child",
"x-spec-enum-id": "d10d91f690a856c2"
},
"label": {
"type": "string",
"enum": [
"Parent",
"Child"
]
}
},
"nullable": true
},
"airflow": {
"type": "object",
"properties": {
"value": {
"enum": [
"front-to-rear",
"rear-to-front",
"left-to-right",
"right-to-left",
"side-to-rear",
"rear-to-side",
"bottom-to-top",
"top-to-bottom",
"passive",
"mixed",
"",
null
],
"type": "string",
"description": "* `front-to-rear` - Front to rear\n* `rear-to-front` - Rear to front\n* `left-to-right` - Left to right\n* `right-to-left` - Right to left\n* `side-to-rear` - Side to rear\n* `rear-to-side` - Rear to side\n* `bottom-to-top` - Bottom to top\n* `top-to-bottom` - Top to bottom\n* `passive` - Passive\n* `mixed` - Mixed",
"x-spec-enum-id": "943288113dad6782"
},
"label": {
"type": "string",
"enum": [
"Front to rear",
"Rear to front",
"Left to right",
"Right to left",
"Side to rear",
"Rear to side",
"Bottom to top",
"Top to bottom",
"Passive",
"Mixed"
]
}
},
"nullable": true
},
"weight": {
"type": "number",
"format": "double",
"maximum": 1000000,
"minimum": -1000000,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true
},
"weight_unit": {
"type": "object",
"properties": {
"value": {
"enum": [
"kg",
"g",
"lb",
"oz",
"",
null
],
"type": "string",
"description": "* `kg` - Kilograms\n* `g` - Grams\n* `lb` - Pounds\n* `oz` - Ounces",
"x-spec-enum-id": "7c1876f422815884"
},
"label": {
"type": "string",
"enum": [
"Kilograms",
"Grams",
"Pounds",
"Ounces"
]
}
},
"nullable": true
},
"front_image": {
"type": "string",
"format": "uri",
"nullable": true
},
"rear_image": {
"type": "string",
"format": "uri",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"device_count": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"console_port_template_count": {
"type": "integer",
"readOnly": true
},
"console_server_port_template_count": {
"type": "integer",
"readOnly": true
},
"power_port_template_count": {
"type": "integer",
"readOnly": true
},
"power_outlet_template_count": {
"type": "integer",
"readOnly": true
},
"interface_template_count": {
"type": "integer",
"readOnly": true
},
"front_port_template_count": {
"type": "integer",
"readOnly": true
},
"rear_port_template_count": {
"type": "integer",
"readOnly": true
},
"device_bay_template_count": {
"type": "integer",
"readOnly": true
},
"module_bay_template_count": {
"type": "integer",
"readOnly": true
},
"inventory_item_template_count": {
"type": "integer",
"readOnly": true
}
},
"required": [
"console_port_template_count",
"console_server_port_template_count",
"created",
"device_bay_template_count",
"device_count",
"display",
"display_url",
"front_port_template_count",
"id",
"interface_template_count",
"inventory_item_template_count",
"last_updated",
"manufacturer",
"model",
"module_bay_template_count",
"power_outlet_template_count",
"power_port_template_count",
"rear_port_template_count",
"slug",
"url"
]
},
"DeviceTypeRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"manufacturer": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefManufacturerRequest"
}
]
},
"default_platform": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefPlatformRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"model": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"part_number": {
"type": "string",
"description": "Discrete part number (optional)",
"maxLength": 50
},
"u_height": {
"type": "number",
"format": "double",
"maximum": 1000,
"minimum": 0.0,
"exclusiveMaximum": true,
"default": 1.0,
"title": "Position (U)"
},
"exclude_from_utilization": {
"type": "boolean",
"description": "Devices of this type are excluded when calculating rack utilization."
},
"is_full_depth": {
"type": "boolean",
"description": "Device consumes both front and rear rack faces."
},
"subdevice_role": {
"enum": [
"parent",
"child",
"",
null
],
"type": "string",
"description": "* `parent` - Parent\n* `child` - Child",
"x-spec-enum-id": "d10d91f690a856c2",
"nullable": true
},
"airflow": {
"enum": [
"front-to-rear",
"rear-to-front",
"left-to-right",
"right-to-left",
"side-to-rear",
"rear-to-side",
"bottom-to-top",
"top-to-bottom",
"passive",
"mixed",
"",
null
],
"type": "string",
"description": "* `front-to-rear` - Front to rear\n* `rear-to-front` - Rear to front\n* `left-to-right` - Left to right\n* `right-to-left` - Right to left\n* `side-to-rear` - Side to rear\n* `rear-to-side` - Rear to side\n* `bottom-to-top` - Bottom to top\n* `top-to-bottom` - Top to bottom\n* `passive` - Passive\n* `mixed` - Mixed",
"x-spec-enum-id": "943288113dad6782",
"nullable": true
},
"weight": {
"type": "number",
"format": "double",
"maximum": 1000000,
"minimum": -1000000,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true
},
"weight_unit": {
"enum": [
"kg",
"g",
"lb",
"oz",
"",
null
],
"type": "string",
"description": "* `kg` - Kilograms\n* `g` - Grams\n* `lb` - Pounds\n* `oz` - Ounces",
"x-spec-enum-id": "7c1876f422815884",
"nullable": true
},
"front_image": {
"type": "string",
"format": "binary",
"nullable": true
},
"rear_image": {
"type": "string",
"format": "binary",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"manufacturer",
"model",
"slug"
]
},
"DeviceWithConfigContext": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"nullable": true,
"maxLength": 64
},
"device_type": {
"$ref": "#/components/schemas/BriefDeviceType"
},
"role": {
"$ref": "#/components/schemas/BriefDeviceRole"
},
"tenant": {
"allOf": [
{
"$ref": "#/components/schemas/BriefTenant"
}
],
"nullable": true
},
"platform": {
"allOf": [
{
"$ref": "#/components/schemas/BriefPlatform"
}
],
"nullable": true
},
"serial": {
"type": "string",
"title": "Serial number",
"description": "Chassis serial number, assigned by the manufacturer",
"maxLength": 50
},
"asset_tag": {
"type": "string",
"nullable": true,
"description": "A unique tag used to identify this device",
"maxLength": 50
},
"site": {
"$ref": "#/components/schemas/BriefSite"
},
"location": {
"allOf": [
{
"$ref": "#/components/schemas/BriefLocation"
}
],
"nullable": true
},
"rack": {
"allOf": [
{
"$ref": "#/components/schemas/BriefRack"
}
],
"nullable": true
},
"position": {
"type": "number",
"format": "double",
"maximum": 1000,
"minimum": 0.5,
"exclusiveMaximum": true,
"nullable": true,
"title": "Position (U)"
},
"face": {
"type": "object",
"properties": {
"value": {
"enum": [
"front",
"rear",
""
],
"type": "string",
"description": "* `front` - Front\n* `rear` - Rear",
"x-spec-enum-id": "d2fb9b3f75158b83"
},
"label": {
"type": "string",
"enum": [
"Front",
"Rear"
]
}
}
},
"latitude": {
"type": "number",
"format": "double",
"maximum": 100,
"minimum": -100,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true,
"description": "GPS coordinate in decimal format (xx.yyyyyy)"
},
"longitude": {
"type": "number",
"format": "double",
"maximum": 1000,
"minimum": -1000,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true,
"description": "GPS coordinate in decimal format (xx.yyyyyy)"
},
"parent_device": {
"allOf": [
{
"$ref": "#/components/schemas/NestedDevice"
}
],
"nullable": true,
"readOnly": true
},
"status": {
"type": "object",
"properties": {
"value": {
"enum": [
"offline",
"active",
"planned",
"staged",
"failed",
"inventory",
"decommissioning"
],
"type": "string",
"description": "* `offline` - Offline\n* `active` - Active\n* `planned` - Planned\n* `staged` - Staged\n* `failed` - Failed\n* `inventory` - Inventory\n* `decommissioning` - Decommissioning",
"x-spec-enum-id": "8d8971779f16ee18"
},
"label": {
"type": "string",
"enum": [
"Offline",
"Active",
"Planned",
"Staged",
"Failed",
"Inventory",
"Decommissioning"
]
}
}
},
"airflow": {
"type": "object",
"properties": {
"value": {
"enum": [
"front-to-rear",
"rear-to-front",
"left-to-right",
"right-to-left",
"side-to-rear",
"rear-to-side",
"bottom-to-top",
"top-to-bottom",
"passive",
"mixed",
""
],
"type": "string",
"description": "* `front-to-rear` - Front to rear\n* `rear-to-front` - Rear to front\n* `left-to-right` - Left to right\n* `right-to-left` - Right to left\n* `side-to-rear` - Side to rear\n* `rear-to-side` - Rear to side\n* `bottom-to-top` - Bottom to top\n* `top-to-bottom` - Top to bottom\n* `passive` - Passive\n* `mixed` - Mixed",
"x-spec-enum-id": "943288113dad6782"
},
"label": {
"type": "string",
"enum": [
"Front to rear",
"Rear to front",
"Left to right",
"Right to left",
"Side to rear",
"Rear to side",
"Bottom to top",
"Top to bottom",
"Passive",
"Mixed"
]
}
}
},
"primary_ip": {
"allOf": [
{
"$ref": "#/components/schemas/BriefIPAddress"
}
],
"readOnly": true,
"nullable": true
},
"primary_ip4": {
"allOf": [
{
"$ref": "#/components/schemas/BriefIPAddress"
}
],
"nullable": true
},
"primary_ip6": {
"allOf": [
{
"$ref": "#/components/schemas/BriefIPAddress"
}
],
"nullable": true
},
"oob_ip": {
"allOf": [
{
"$ref": "#/components/schemas/BriefIPAddress"
}
],
"nullable": true
},
"cluster": {
"allOf": [
{
"$ref": "#/components/schemas/BriefCluster"
}
],
"nullable": true
},
"virtual_chassis": {
"allOf": [
{
"$ref": "#/components/schemas/BriefVirtualChassis"
}
],
"nullable": true
},
"vc_position": {
"type": "integer",
"maximum": 255,
"minimum": 0,
"nullable": true
},
"vc_priority": {
"type": "integer",
"maximum": 255,
"minimum": 0,
"nullable": true,
"description": "Virtual chassis master election priority"
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"config_template": {
"allOf": [
{
"$ref": "#/components/schemas/BriefConfigTemplate"
}
],
"nullable": true
},
"config_context": {
"nullable": true,
"readOnly": true
},
"local_context_data": {
"nullable": true,
"description": "Local config context data takes precedence over source contexts in the final rendered config context"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"console_port_count": {
"type": "integer",
"readOnly": true
},
"console_server_port_count": {
"type": "integer",
"readOnly": true
},
"power_port_count": {
"type": "integer",
"readOnly": true
},
"power_outlet_count": {
"type": "integer",
"readOnly": true
},
"interface_count": {
"type": "integer",
"readOnly": true
},
"front_port_count": {
"type": "integer",
"readOnly": true
},
"rear_port_count": {
"type": "integer",
"readOnly": true
},
"device_bay_count": {
"type": "integer",
"readOnly": true
},
"module_bay_count": {
"type": "integer",
"readOnly": true
},
"inventory_item_count": {
"type": "integer",
"readOnly": true
}
},
"required": [
"config_context",
"console_port_count",
"console_server_port_count",
"created",
"device_bay_count",
"device_type",
"display",
"display_url",
"front_port_count",
"id",
"interface_count",
"inventory_item_count",
"last_updated",
"module_bay_count",
"parent_device",
"power_outlet_count",
"power_port_count",
"primary_ip",
"rear_port_count",
"role",
"site",
"url"
]
},
"DeviceWithConfigContextRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"nullable": true,
"maxLength": 64
},
"device_type": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDeviceTypeRequest"
}
]
},
"role": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDeviceRoleRequest"
}
]
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"platform": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefPlatformRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"serial": {
"type": "string",
"title": "Serial number",
"description": "Chassis serial number, assigned by the manufacturer",
"maxLength": 50
},
"asset_tag": {
"type": "string",
"nullable": true,
"description": "A unique tag used to identify this device",
"maxLength": 50
},
"site": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefSiteRequest"
}
]
},
"location": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefLocationRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"rack": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefRackRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"position": {
"type": "number",
"format": "double",
"maximum": 1000,
"minimum": 0.5,
"exclusiveMaximum": true,
"nullable": true,
"title": "Position (U)"
},
"face": {
"enum": [
"front",
"rear",
""
],
"type": "string",
"description": "* `front` - Front\n* `rear` - Rear",
"x-spec-enum-id": "d2fb9b3f75158b83"
},
"latitude": {
"type": "number",
"format": "double",
"maximum": 100,
"minimum": -100,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true,
"description": "GPS coordinate in decimal format (xx.yyyyyy)"
},
"longitude": {
"type": "number",
"format": "double",
"maximum": 1000,
"minimum": -1000,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true,
"description": "GPS coordinate in decimal format (xx.yyyyyy)"
},
"status": {
"enum": [
"offline",
"active",
"planned",
"staged",
"failed",
"inventory",
"decommissioning"
],
"type": "string",
"description": "* `offline` - Offline\n* `active` - Active\n* `planned` - Planned\n* `staged` - Staged\n* `failed` - Failed\n* `inventory` - Inventory\n* `decommissioning` - Decommissioning",
"x-spec-enum-id": "8d8971779f16ee18"
},
"airflow": {
"enum": [
"front-to-rear",
"rear-to-front",
"left-to-right",
"right-to-left",
"side-to-rear",
"rear-to-side",
"bottom-to-top",
"top-to-bottom",
"passive",
"mixed",
""
],
"type": "string",
"description": "* `front-to-rear` - Front to rear\n* `rear-to-front` - Rear to front\n* `left-to-right` - Left to right\n* `right-to-left` - Right to left\n* `side-to-rear` - Side to rear\n* `rear-to-side` - Rear to side\n* `bottom-to-top` - Bottom to top\n* `top-to-bottom` - Top to bottom\n* `passive` - Passive\n* `mixed` - Mixed",
"x-spec-enum-id": "943288113dad6782"
},
"primary_ip4": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefIPAddressRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"primary_ip6": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefIPAddressRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"oob_ip": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefIPAddressRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"cluster": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefClusterRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"virtual_chassis": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefVirtualChassisRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"vc_position": {
"type": "integer",
"maximum": 255,
"minimum": 0,
"nullable": true
},
"vc_priority": {
"type": "integer",
"maximum": 255,
"minimum": 0,
"nullable": true,
"description": "Virtual chassis master election priority"
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"config_template": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefConfigTemplateRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"local_context_data": {
"nullable": true,
"description": "Local config context data takes precedence over source contexts in the final rendered config context"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"device_type",
"role",
"site"
]
},
"EventRule": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"object_types": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string",
"maxLength": 150
},
"enabled": {
"type": "boolean"
},
"event_types": {
"type": "array",
"items": {
"enum": [
"object_created",
"object_updated",
"object_deleted",
"job_started",
"job_completed",
"job_failed",
"job_errored"
],
"type": "string",
"description": "* `object_created` - Object created\n* `object_updated` - Object updated\n* `object_deleted` - Object deleted\n* `job_started` - Job started\n* `job_completed` - Job completed\n* `job_failed` - Job failed\n* `job_errored` - Job errored",
"x-spec-enum-id": "80d172232f4af424"
},
"description": "The types of event which will trigger this rule."
},
"conditions": {
"nullable": true,
"description": "A set of conditions which determine whether the event will be generated."
},
"action_type": {
"type": "object",
"properties": {
"value": {
"enum": [
"webhook",
"script",
"notification"
],
"type": "string",
"description": "* `webhook` - Webhook\n* `script` - Script\n* `notification` - Notification",
"x-spec-enum-id": "d07193c73ebc03c6"
},
"label": {
"type": "string",
"enum": [
"Webhook",
"Script",
"Notification"
]
}
}
},
"action_object_type": {
"type": "string"
},
"action_object_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64",
"nullable": true
},
"action_object": {
"type": "object",
"additionalProperties": {},
"readOnly": true
},
"description": {
"type": "string",
"maxLength": 200
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"action_object",
"action_object_type",
"action_type",
"created",
"display",
"display_url",
"event_types",
"id",
"last_updated",
"name",
"object_types",
"url"
]
},
"EventRuleRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"object_types": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 150
},
"enabled": {
"type": "boolean"
},
"event_types": {
"type": "array",
"items": {
"enum": [
"object_created",
"object_updated",
"object_deleted",
"job_started",
"job_completed",
"job_failed",
"job_errored"
],
"type": "string",
"description": "* `object_created` - Object created\n* `object_updated` - Object updated\n* `object_deleted` - Object deleted\n* `job_started` - Job started\n* `job_completed` - Job completed\n* `job_failed` - Job failed\n* `job_errored` - Job errored",
"x-spec-enum-id": "80d172232f4af424"
},
"description": "The types of event which will trigger this rule."
},
"conditions": {
"nullable": true,
"description": "A set of conditions which determine whether the event will be generated."
},
"action_type": {
"enum": [
"webhook",
"script",
"notification"
],
"type": "string",
"description": "* `webhook` - Webhook\n* `script` - Script\n* `notification` - Notification",
"x-spec-enum-id": "d07193c73ebc03c6"
},
"action_object_type": {
"type": "string"
},
"action_object_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
}
},
"required": [
"action_object_type",
"action_type",
"event_types",
"name",
"object_types"
]
},
"ExportTemplate": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"object_types": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string",
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"environment_params": {
"nullable": true,
"title": "Environment parameters",
"description": "Any additional parameters to pass when constructing the Jinja environment"
},
"template_code": {
"type": "string",
"description": "Jinja template code."
},
"mime_type": {
"type": "string",
"description": "Defaults to text/plain; charset=utf-8",
"maxLength": 50
},
"file_name": {
"type": "string",
"description": "Filename to give to the rendered export file",
"maxLength": 200
},
"file_extension": {
"type": "string",
"description": "Extension to append to the rendered filename",
"maxLength": 15
},
"as_attachment": {
"type": "boolean",
"description": "Download file as attachment"
},
"data_source": {
"$ref": "#/components/schemas/BriefDataSource"
},
"data_path": {
"type": "string",
"readOnly": true,
"description": "Path to remote file (relative to data source root)"
},
"data_file": {
"allOf": [
{
"$ref": "#/components/schemas/BriefDataFile"
}
],
"readOnly": true
},
"data_synced": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true,
"title": "Date synced"
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"created",
"data_file",
"data_path",
"data_synced",
"display",
"display_url",
"id",
"last_updated",
"name",
"object_types",
"template_code",
"url"
]
},
"ExportTemplateRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"object_types": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"environment_params": {
"nullable": true,
"title": "Environment parameters",
"description": "Any additional parameters to pass when constructing the Jinja environment"
},
"template_code": {
"type": "string",
"minLength": 1,
"description": "Jinja template code."
},
"mime_type": {
"type": "string",
"description": "Defaults to text/plain; charset=utf-8",
"maxLength": 50
},
"file_name": {
"type": "string",
"description": "Filename to give to the rendered export file",
"maxLength": 200
},
"file_extension": {
"type": "string",
"description": "Extension to append to the rendered filename",
"maxLength": 15
},
"as_attachment": {
"type": "boolean",
"description": "Download file as attachment"
},
"data_source": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDataSourceRequest"
}
]
}
},
"required": [
"name",
"object_types",
"template_code"
]
},
"FHRPGroup": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"protocol": {
"enum": [
"vrrp2",
"vrrp3",
"carp",
"clusterxl",
"hsrp",
"glbp",
"other"
],
"type": "string",
"description": "* `vrrp2` - VRRPv2\n* `vrrp3` - VRRPv3\n* `carp` - CARP\n* `clusterxl` - ClusterXL\n* `hsrp` - HSRP\n* `glbp` - GLBP\n* `other` - Other",
"x-spec-enum-id": "40dc831c689b4b78"
},
"group_id": {
"type": "integer",
"maximum": 32767,
"minimum": 0
},
"auth_type": {
"enum": [
"plaintext",
"md5",
"",
null
],
"type": "string",
"description": "* `plaintext` - Plaintext\n* `md5` - MD5",
"x-spec-enum-id": "12b9faea3a45bf37",
"nullable": true,
"title": "Authentication type"
},
"auth_key": {
"type": "string",
"title": "Authentication key",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"ip_addresses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BriefIPAddress"
},
"readOnly": true
}
},
"required": [
"created",
"display",
"display_url",
"group_id",
"id",
"ip_addresses",
"last_updated",
"protocol",
"url"
]
},
"FHRPGroupAssignment": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"group": {
"$ref": "#/components/schemas/BriefFHRPGroup"
},
"interface_type": {
"type": "string"
},
"interface_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64"
},
"interface": {
"nullable": true,
"readOnly": true
},
"priority": {
"type": "integer",
"maximum": 255,
"minimum": 0
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"created",
"display",
"group",
"id",
"interface",
"interface_id",
"interface_type",
"last_updated",
"priority",
"url"
]
},
"FHRPGroupAssignmentRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"group": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefFHRPGroupRequest"
}
]
},
"interface_type": {
"type": "string"
},
"interface_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64"
},
"priority": {
"type": "integer",
"maximum": 255,
"minimum": 0
}
},
"required": [
"group",
"interface_id",
"interface_type",
"priority"
]
},
"FHRPGroupRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"maxLength": 100
},
"protocol": {
"enum": [
"vrrp2",
"vrrp3",
"carp",
"clusterxl",
"hsrp",
"glbp",
"other"
],
"type": "string",
"description": "* `vrrp2` - VRRPv2\n* `vrrp3` - VRRPv3\n* `carp` - CARP\n* `clusterxl` - ClusterXL\n* `hsrp` - HSRP\n* `glbp` - GLBP\n* `other` - Other",
"x-spec-enum-id": "40dc831c689b4b78"
},
"group_id": {
"type": "integer",
"maximum": 32767,
"minimum": 0
},
"auth_type": {
"enum": [
"plaintext",
"md5",
"",
null
],
"type": "string",
"description": "* `plaintext` - Plaintext\n* `md5` - MD5",
"x-spec-enum-id": "12b9faea3a45bf37",
"nullable": true,
"title": "Authentication type"
},
"auth_key": {
"type": "string",
"title": "Authentication key",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"group_id",
"protocol"
]
},
"FrontPort": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"device": {
"$ref": "#/components/schemas/BriefDevice"
},
"module": {
"allOf": [
{
"$ref": "#/components/schemas/BriefModule"
}
],
"nullable": true
},
"name": {
"type": "string",
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"type": "object",
"properties": {
"value": {
"enum": [
"8p8c",
"8p6c",
"8p4c",
"8p2c",
"6p6c",
"6p4c",
"6p2c",
"4p4c",
"4p2c",
"gg45",
"tera-4p",
"tera-2p",
"tera-1p",
"110-punch",
"bnc",
"f",
"n",
"mrj21",
"fc",
"fc-pc",
"fc-upc",
"fc-apc",
"lc",
"lc-pc",
"lc-upc",
"lc-apc",
"lsh",
"lsh-pc",
"lsh-upc",
"lsh-apc",
"lx5",
"lx5-pc",
"lx5-upc",
"lx5-apc",
"mpo",
"mtrj",
"sc",
"sc-pc",
"sc-upc",
"sc-apc",
"st",
"cs",
"sn",
"sma-905",
"sma-906",
"urm-p2",
"urm-p4",
"urm-p8",
"splice",
"usb-a",
"usb-b",
"usb-c",
"usb-mini-a",
"usb-mini-b",
"usb-micro-a",
"usb-micro-b",
"usb-micro-ab",
"other"
],
"type": "string",
"description": "* `8p8c` - 8P8C\n* `8p6c` - 8P6C\n* `8p4c` - 8P4C\n* `8p2c` - 8P2C\n* `6p6c` - 6P6C\n* `6p4c` - 6P4C\n* `6p2c` - 6P2C\n* `4p4c` - 4P4C\n* `4p2c` - 4P2C\n* `gg45` - GG45\n* `tera-4p` - TERA 4P\n* `tera-2p` - TERA 2P\n* `tera-1p` - TERA 1P\n* `110-punch` - 110 Punch\n* `bnc` - BNC\n* `f` - F Connector\n* `n` - N Connector\n* `mrj21` - MRJ21\n* `fc` - FC\n* `fc-pc` - FC/PC\n* `fc-upc` - FC/UPC\n* `fc-apc` - FC/APC\n* `lc` - LC\n* `lc-pc` - LC/PC\n* `lc-upc` - LC/UPC\n* `lc-apc` - LC/APC\n* `lsh` - LSH\n* `lsh-pc` - LSH/PC\n* `lsh-upc` - LSH/UPC\n* `lsh-apc` - LSH/APC\n* `lx5` - LX.5\n* `lx5-pc` - LX.5/PC\n* `lx5-upc` - LX.5/UPC\n* `lx5-apc` - LX.5/APC\n* `mpo` - MPO\n* `mtrj` - MTRJ\n* `sc` - SC\n* `sc-pc` - SC/PC\n* `sc-upc` - SC/UPC\n* `sc-apc` - SC/APC\n* `st` - ST\n* `cs` - CS\n* `sn` - SN\n* `sma-905` - SMA 905\n* `sma-906` - SMA 906\n* `urm-p2` - URM-P2\n* `urm-p4` - URM-P4\n* `urm-p8` - URM-P8\n* `splice` - Splice\n* `usb-a` - USB Type A\n* `usb-b` - USB Type B\n* `usb-c` - USB Type C\n* `usb-mini-a` - USB Mini A\n* `usb-mini-b` - USB Mini B\n* `usb-micro-a` - USB Micro A\n* `usb-micro-b` - USB Micro B\n* `usb-micro-ab` - USB Micro AB\n* `other` - Other",
"x-spec-enum-id": "ea67ae8ba4602f8a"
},
"label": {
"type": "string",
"enum": [
"8P8C",
"8P6C",
"8P4C",
"8P2C",
"6P6C",
"6P4C",
"6P2C",
"4P4C",
"4P2C",
"GG45",
"TERA 4P",
"TERA 2P",
"TERA 1P",
"110 Punch",
"BNC",
"F Connector",
"N Connector",
"MRJ21",
"FC",
"FC/PC",
"FC/UPC",
"FC/APC",
"LC",
"LC/PC",
"LC/UPC",
"LC/APC",
"LSH",
"LSH/PC",
"LSH/UPC",
"LSH/APC",
"LX.5",
"LX.5/PC",
"LX.5/UPC",
"LX.5/APC",
"MPO",
"MTRJ",
"SC",
"SC/PC",
"SC/UPC",
"SC/APC",
"ST",
"CS",
"SN",
"SMA 905",
"SMA 906",
"URM-P2",
"URM-P4",
"URM-P8",
"Splice",
"USB Type A",
"USB Type B",
"USB Type C",
"USB Mini A",
"USB Mini B",
"USB Micro A",
"USB Micro B",
"USB Micro AB",
"Other"
]
}
}
},
"color": {
"type": "string",
"pattern": "^[0-9a-f]{6}$",
"maxLength": 6
},
"rear_port": {
"$ref": "#/components/schemas/FrontPortRearPort"
},
"rear_port_position": {
"type": "integer",
"maximum": 1024,
"minimum": 1,
"description": "Mapped position on corresponding rear port"
},
"description": {
"type": "string",
"maxLength": 200
},
"mark_connected": {
"type": "boolean",
"description": "Treat as if a cable is connected"
},
"cable": {
"allOf": [
{
"$ref": "#/components/schemas/BriefCable"
}
],
"readOnly": true,
"nullable": true
},
"cable_end": {
"type": "string",
"readOnly": true
},
"link_peers": {
"type": "array",
"items": {},
"readOnly": true
},
"link_peers_type": {
"type": "string",
"description": "Return the type of the peer link terminations, or None.",
"readOnly": true,
"nullable": true
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"_occupied": {
"type": "boolean",
"readOnly": true,
"title": " occupied"
}
},
"required": [
"_occupied",
"cable",
"cable_end",
"created",
"device",
"display",
"display_url",
"id",
"last_updated",
"link_peers",
"link_peers_type",
"name",
"rear_port",
"type",
"url"
]
},
"FrontPortRearPort": {
"type": "object",
"description": "NestedRearPortSerializer but with parent device omitted (since front and rear ports must belong to same device)",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"display",
"display_url",
"id",
"name",
"url"
]
},
"FrontPortRearPortRequest": {
"type": "object",
"description": "NestedRearPortSerializer but with parent device omitted (since front and rear ports must belong to same device)",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name"
]
},
"FrontPortRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"device": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDeviceRequest"
}
]
},
"module": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"enum": [
"8p8c",
"8p6c",
"8p4c",
"8p2c",
"6p6c",
"6p4c",
"6p2c",
"4p4c",
"4p2c",
"gg45",
"tera-4p",
"tera-2p",
"tera-1p",
"110-punch",
"bnc",
"f",
"n",
"mrj21",
"fc",
"fc-pc",
"fc-upc",
"fc-apc",
"lc",
"lc-pc",
"lc-upc",
"lc-apc",
"lsh",
"lsh-pc",
"lsh-upc",
"lsh-apc",
"lx5",
"lx5-pc",
"lx5-upc",
"lx5-apc",
"mpo",
"mtrj",
"sc",
"sc-pc",
"sc-upc",
"sc-apc",
"st",
"cs",
"sn",
"sma-905",
"sma-906",
"urm-p2",
"urm-p4",
"urm-p8",
"splice",
"usb-a",
"usb-b",
"usb-c",
"usb-mini-a",
"usb-mini-b",
"usb-micro-a",
"usb-micro-b",
"usb-micro-ab",
"other"
],
"type": "string",
"description": "* `8p8c` - 8P8C\n* `8p6c` - 8P6C\n* `8p4c` - 8P4C\n* `8p2c` - 8P2C\n* `6p6c` - 6P6C\n* `6p4c` - 6P4C\n* `6p2c` - 6P2C\n* `4p4c` - 4P4C\n* `4p2c` - 4P2C\n* `gg45` - GG45\n* `tera-4p` - TERA 4P\n* `tera-2p` - TERA 2P\n* `tera-1p` - TERA 1P\n* `110-punch` - 110 Punch\n* `bnc` - BNC\n* `f` - F Connector\n* `n` - N Connector\n* `mrj21` - MRJ21\n* `fc` - FC\n* `fc-pc` - FC/PC\n* `fc-upc` - FC/UPC\n* `fc-apc` - FC/APC\n* `lc` - LC\n* `lc-pc` - LC/PC\n* `lc-upc` - LC/UPC\n* `lc-apc` - LC/APC\n* `lsh` - LSH\n* `lsh-pc` - LSH/PC\n* `lsh-upc` - LSH/UPC\n* `lsh-apc` - LSH/APC\n* `lx5` - LX.5\n* `lx5-pc` - LX.5/PC\n* `lx5-upc` - LX.5/UPC\n* `lx5-apc` - LX.5/APC\n* `mpo` - MPO\n* `mtrj` - MTRJ\n* `sc` - SC\n* `sc-pc` - SC/PC\n* `sc-upc` - SC/UPC\n* `sc-apc` - SC/APC\n* `st` - ST\n* `cs` - CS\n* `sn` - SN\n* `sma-905` - SMA 905\n* `sma-906` - SMA 906\n* `urm-p2` - URM-P2\n* `urm-p4` - URM-P4\n* `urm-p8` - URM-P8\n* `splice` - Splice\n* `usb-a` - USB Type A\n* `usb-b` - USB Type B\n* `usb-c` - USB Type C\n* `usb-mini-a` - USB Mini A\n* `usb-mini-b` - USB Mini B\n* `usb-micro-a` - USB Micro A\n* `usb-micro-b` - USB Micro B\n* `usb-micro-ab` - USB Micro AB\n* `other` - Other",
"x-spec-enum-id": "ea67ae8ba4602f8a"
},
"color": {
"type": "string",
"pattern": "^[0-9a-f]{6}$",
"maxLength": 6
},
"rear_port": {
"$ref": "#/components/schemas/FrontPortRearPortRequest"
},
"rear_port_position": {
"type": "integer",
"maximum": 1024,
"minimum": 1,
"description": "Mapped position on corresponding rear port"
},
"description": {
"type": "string",
"maxLength": 200
},
"mark_connected": {
"type": "boolean",
"description": "Treat as if a cable is connected"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"device",
"name",
"rear_port",
"type"
]
},
"FrontPortTemplate": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"device_type": {
"allOf": [
{
"$ref": "#/components/schemas/BriefDeviceType"
}
],
"nullable": true
},
"module_type": {
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleType"
}
],
"nullable": true
},
"name": {
"type": "string",
"description": "{module} is accepted as a substitution for the module bay position when attached to a module type.",
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"type": "object",
"properties": {
"value": {
"enum": [
"8p8c",
"8p6c",
"8p4c",
"8p2c",
"6p6c",
"6p4c",
"6p2c",
"4p4c",
"4p2c",
"gg45",
"tera-4p",
"tera-2p",
"tera-1p",
"110-punch",
"bnc",
"f",
"n",
"mrj21",
"fc",
"fc-pc",
"fc-upc",
"fc-apc",
"lc",
"lc-pc",
"lc-upc",
"lc-apc",
"lsh",
"lsh-pc",
"lsh-upc",
"lsh-apc",
"lx5",
"lx5-pc",
"lx5-upc",
"lx5-apc",
"mpo",
"mtrj",
"sc",
"sc-pc",
"sc-upc",
"sc-apc",
"st",
"cs",
"sn",
"sma-905",
"sma-906",
"urm-p2",
"urm-p4",
"urm-p8",
"splice",
"usb-a",
"usb-b",
"usb-c",
"usb-mini-a",
"usb-mini-b",
"usb-micro-a",
"usb-micro-b",
"usb-micro-ab",
"other"
],
"type": "string",
"description": "* `8p8c` - 8P8C\n* `8p6c` - 8P6C\n* `8p4c` - 8P4C\n* `8p2c` - 8P2C\n* `6p6c` - 6P6C\n* `6p4c` - 6P4C\n* `6p2c` - 6P2C\n* `4p4c` - 4P4C\n* `4p2c` - 4P2C\n* `gg45` - GG45\n* `tera-4p` - TERA 4P\n* `tera-2p` - TERA 2P\n* `tera-1p` - TERA 1P\n* `110-punch` - 110 Punch\n* `bnc` - BNC\n* `f` - F Connector\n* `n` - N Connector\n* `mrj21` - MRJ21\n* `fc` - FC\n* `fc-pc` - FC/PC\n* `fc-upc` - FC/UPC\n* `fc-apc` - FC/APC\n* `lc` - LC\n* `lc-pc` - LC/PC\n* `lc-upc` - LC/UPC\n* `lc-apc` - LC/APC\n* `lsh` - LSH\n* `lsh-pc` - LSH/PC\n* `lsh-upc` - LSH/UPC\n* `lsh-apc` - LSH/APC\n* `lx5` - LX.5\n* `lx5-pc` - LX.5/PC\n* `lx5-upc` - LX.5/UPC\n* `lx5-apc` - LX.5/APC\n* `mpo` - MPO\n* `mtrj` - MTRJ\n* `sc` - SC\n* `sc-pc` - SC/PC\n* `sc-upc` - SC/UPC\n* `sc-apc` - SC/APC\n* `st` - ST\n* `cs` - CS\n* `sn` - SN\n* `sma-905` - SMA 905\n* `sma-906` - SMA 906\n* `urm-p2` - URM-P2\n* `urm-p4` - URM-P4\n* `urm-p8` - URM-P8\n* `splice` - Splice\n* `usb-a` - USB Type A\n* `usb-b` - USB Type B\n* `usb-c` - USB Type C\n* `usb-mini-a` - USB Mini A\n* `usb-mini-b` - USB Mini B\n* `usb-micro-a` - USB Micro A\n* `usb-micro-b` - USB Micro B\n* `usb-micro-ab` - USB Micro AB\n* `other` - Other",
"x-spec-enum-id": "ea67ae8ba4602f8a"
},
"label": {
"type": "string",
"enum": [
"8P8C",
"8P6C",
"8P4C",
"8P2C",
"6P6C",
"6P4C",
"6P2C",
"4P4C",
"4P2C",
"GG45",
"TERA 4P",
"TERA 2P",
"TERA 1P",
"110 Punch",
"BNC",
"F Connector",
"N Connector",
"MRJ21",
"FC",
"FC/PC",
"FC/UPC",
"FC/APC",
"LC",
"LC/PC",
"LC/UPC",
"LC/APC",
"LSH",
"LSH/PC",
"LSH/UPC",
"LSH/APC",
"LX.5",
"LX.5/PC",
"LX.5/UPC",
"LX.5/APC",
"MPO",
"MTRJ",
"SC",
"SC/PC",
"SC/UPC",
"SC/APC",
"ST",
"CS",
"SN",
"SMA 905",
"SMA 906",
"URM-P2",
"URM-P4",
"URM-P8",
"Splice",
"USB Type A",
"USB Type B",
"USB Type C",
"USB Mini A",
"USB Mini B",
"USB Micro A",
"USB Micro B",
"USB Micro AB",
"Other"
]
}
}
},
"color": {
"type": "string",
"pattern": "^[0-9a-f]{6}$",
"maxLength": 6
},
"rear_port": {
"$ref": "#/components/schemas/BriefRearPortTemplate"
},
"rear_port_position": {
"type": "integer",
"maximum": 1024,
"minimum": 1
},
"description": {
"type": "string",
"maxLength": 200
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"created",
"display",
"id",
"last_updated",
"name",
"rear_port",
"type",
"url"
]
},
"FrontPortTemplateRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"device_type": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefDeviceTypeRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"module_type": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleTypeRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"description": "{module} is accepted as a substitution for the module bay position when attached to a module type.",
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"enum": [
"8p8c",
"8p6c",
"8p4c",
"8p2c",
"6p6c",
"6p4c",
"6p2c",
"4p4c",
"4p2c",
"gg45",
"tera-4p",
"tera-2p",
"tera-1p",
"110-punch",
"bnc",
"f",
"n",
"mrj21",
"fc",
"fc-pc",
"fc-upc",
"fc-apc",
"lc",
"lc-pc",
"lc-upc",
"lc-apc",
"lsh",
"lsh-pc",
"lsh-upc",
"lsh-apc",
"lx5",
"lx5-pc",
"lx5-upc",
"lx5-apc",
"mpo",
"mtrj",
"sc",
"sc-pc",
"sc-upc",
"sc-apc",
"st",
"cs",
"sn",
"sma-905",
"sma-906",
"urm-p2",
"urm-p4",
"urm-p8",
"splice",
"usb-a",
"usb-b",
"usb-c",
"usb-mini-a",
"usb-mini-b",
"usb-micro-a",
"usb-micro-b",
"usb-micro-ab",
"other"
],
"type": "string",
"description": "* `8p8c` - 8P8C\n* `8p6c` - 8P6C\n* `8p4c` - 8P4C\n* `8p2c` - 8P2C\n* `6p6c` - 6P6C\n* `6p4c` - 6P4C\n* `6p2c` - 6P2C\n* `4p4c` - 4P4C\n* `4p2c` - 4P2C\n* `gg45` - GG45\n* `tera-4p` - TERA 4P\n* `tera-2p` - TERA 2P\n* `tera-1p` - TERA 1P\n* `110-punch` - 110 Punch\n* `bnc` - BNC\n* `f` - F Connector\n* `n` - N Connector\n* `mrj21` - MRJ21\n* `fc` - FC\n* `fc-pc` - FC/PC\n* `fc-upc` - FC/UPC\n* `fc-apc` - FC/APC\n* `lc` - LC\n* `lc-pc` - LC/PC\n* `lc-upc` - LC/UPC\n* `lc-apc` - LC/APC\n* `lsh` - LSH\n* `lsh-pc` - LSH/PC\n* `lsh-upc` - LSH/UPC\n* `lsh-apc` - LSH/APC\n* `lx5` - LX.5\n* `lx5-pc` - LX.5/PC\n* `lx5-upc` - LX.5/UPC\n* `lx5-apc` - LX.5/APC\n* `mpo` - MPO\n* `mtrj` - MTRJ\n* `sc` - SC\n* `sc-pc` - SC/PC\n* `sc-upc` - SC/UPC\n* `sc-apc` - SC/APC\n* `st` - ST\n* `cs` - CS\n* `sn` - SN\n* `sma-905` - SMA 905\n* `sma-906` - SMA 906\n* `urm-p2` - URM-P2\n* `urm-p4` - URM-P4\n* `urm-p8` - URM-P8\n* `splice` - Splice\n* `usb-a` - USB Type A\n* `usb-b` - USB Type B\n* `usb-c` - USB Type C\n* `usb-mini-a` - USB Mini A\n* `usb-mini-b` - USB Mini B\n* `usb-micro-a` - USB Micro A\n* `usb-micro-b` - USB Micro B\n* `usb-micro-ab` - USB Micro AB\n* `other` - Other",
"x-spec-enum-id": "ea67ae8ba4602f8a"
},
"color": {
"type": "string",
"pattern": "^[0-9a-f]{6}$",
"maxLength": 6
},
"rear_port": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefRearPortTemplateRequest"
}
]
},
"rear_port_position": {
"type": "integer",
"maximum": 1024,
"minimum": 1
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name",
"rear_port",
"type"
]
},
"GenericObject": {
"type": "object",
"description": "Minimal representation of some generic object identified by ContentType and PK.",
"properties": {
"object_type": {
"type": "string"
},
"object_id": {
"type": "integer"
},
"object": {
"nullable": true,
"readOnly": true
}
},
"required": [
"object",
"object_id",
"object_type"
]
},
"GenericObjectRequest": {
"type": "object",
"description": "Minimal representation of some generic object identified by ContentType and PK.",
"properties": {
"object_type": {
"type": "string"
},
"object_id": {
"type": "integer"
}
},
"required": [
"object_id",
"object_type"
]
},
"Group": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 150
},
"description": {
"type": "string",
"maxLength": 200
},
"permissions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ObjectPermission"
}
},
"user_count": {
"type": "integer",
"readOnly": true
}
},
"required": [
"display",
"display_url",
"id",
"name",
"url",
"user_count"
]
},
"GroupRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 150
},
"description": {
"type": "string",
"maxLength": 200
},
"permissions": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"required": [
"name"
]
},
"IKEPolicy": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"version": {
"type": "object",
"properties": {
"value": {
"enum": [
1,
2
],
"type": "integer",
"description": "* `1` - IKEv1\n* `2` - IKEv2",
"x-spec-enum-id": "00872b77916a1fde"
},
"label": {
"type": "string",
"enum": [
"IKEv1",
"IKEv2"
]
}
}
},
"mode": {
"type": "object",
"properties": {
"value": {
"enum": [
"aggressive",
"main"
],
"type": "string",
"description": "* `aggressive` - Aggressive\n* `main` - Main",
"x-spec-enum-id": "64c1be7bdb2548ca"
},
"label": {
"type": "string",
"enum": [
"Aggressive",
"Main"
]
}
}
},
"proposals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IKEProposal"
}
},
"preshared_key": {
"type": "string",
"title": "Pre-shared key"
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"created",
"display",
"display_url",
"id",
"last_updated",
"name",
"url",
"version"
]
},
"IKEPolicyRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"version": {
"enum": [
1,
2
],
"type": "integer",
"description": "* `1` - IKEv1\n* `2` - IKEv2",
"x-spec-enum-id": "00872b77916a1fde"
},
"mode": {
"enum": [
"aggressive",
"main"
],
"type": "string",
"description": "* `aggressive` - Aggressive\n* `main` - Main",
"x-spec-enum-id": "64c1be7bdb2548ca"
},
"proposals": {
"type": "array",
"items": {
"type": "integer"
}
},
"preshared_key": {
"type": "string",
"title": "Pre-shared key"
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name",
"version"
]
},
"IKEProposal": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"authentication_method": {
"type": "object",
"properties": {
"value": {
"enum": [
"preshared-keys",
"certificates",
"rsa-signatures",
"dsa-signatures"
],
"type": "string",
"description": "* `preshared-keys` - Pre-shared keys\n* `certificates` - Certificates\n* `rsa-signatures` - RSA signatures\n* `dsa-signatures` - DSA signatures",
"x-spec-enum-id": "92bb2f1103b3a262"
},
"label": {
"type": "string",
"enum": [
"Pre-shared keys",
"Certificates",
"RSA signatures",
"DSA signatures"
]
}
}
},
"encryption_algorithm": {
"type": "object",
"properties": {
"value": {
"enum": [
"aes-128-cbc",
"aes-128-gcm",
"aes-192-cbc",
"aes-192-gcm",
"aes-256-cbc",
"aes-256-gcm",
"3des-cbc",
"des-cbc"
],
"type": "string",
"description": "* `aes-128-cbc` - 128-bit AES (CBC)\n* `aes-128-gcm` - 128-bit AES (GCM)\n* `aes-192-cbc` - 192-bit AES (CBC)\n* `aes-192-gcm` - 192-bit AES (GCM)\n* `aes-256-cbc` - 256-bit AES (CBC)\n* `aes-256-gcm` - 256-bit AES (GCM)\n* `3des-cbc` - 3DES\n* `des-cbc` - DES",
"x-spec-enum-id": "b022535cfdee79fe"
},
"label": {
"type": "string",
"enum": [
"128-bit AES (CBC)",
"128-bit AES (GCM)",
"192-bit AES (CBC)",
"192-bit AES (GCM)",
"256-bit AES (CBC)",
"256-bit AES (GCM)",
"3DES",
"DES"
]
}
}
},
"authentication_algorithm": {
"type": "object",
"properties": {
"value": {
"enum": [
"hmac-sha1",
"hmac-sha256",
"hmac-sha384",
"hmac-sha512",
"hmac-md5"
],
"type": "string",
"description": "* `hmac-sha1` - SHA-1 HMAC\n* `hmac-sha256` - SHA-256 HMAC\n* `hmac-sha384` - SHA-384 HMAC\n* `hmac-sha512` - SHA-512 HMAC\n* `hmac-md5` - MD5 HMAC",
"x-spec-enum-id": "0830e8839f5dea4f"
},
"label": {
"type": "string",
"enum": [
"SHA-1 HMAC",
"SHA-256 HMAC",
"SHA-384 HMAC",
"SHA-512 HMAC",
"MD5 HMAC"
]
}
}
},
"group": {
"type": "object",
"properties": {
"value": {
"enum": [
1,
2,
5,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34
],
"type": "integer",
"description": "* `1` - Group 1\n* `2` - Group 2\n* `5` - Group 5\n* `14` - Group 14\n* `15` - Group 15\n* `16` - Group 16\n* `17` - Group 17\n* `18` - Group 18\n* `19` - Group 19\n* `20` - Group 20\n* `21` - Group 21\n* `22` - Group 22\n* `23` - Group 23\n* `24` - Group 24\n* `25` - Group 25\n* `26` - Group 26\n* `27` - Group 27\n* `28` - Group 28\n* `29` - Group 29\n* `30` - Group 30\n* `31` - Group 31\n* `32` - Group 32\n* `33` - Group 33\n* `34` - Group 34",
"x-spec-enum-id": "dbef43be795462a8"
},
"label": {
"type": "string",
"enum": [
"Group 1",
"Group 2",
"Group 5",
"Group 14",
"Group 15",
"Group 16",
"Group 17",
"Group 18",
"Group 19",
"Group 20",
"Group 21",
"Group 22",
"Group 23",
"Group 24",
"Group 25",
"Group 26",
"Group 27",
"Group 28",
"Group 29",
"Group 30",
"Group 31",
"Group 32",
"Group 33",
"Group 34"
]
}
}
},
"sa_lifetime": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"description": "Security association lifetime (in seconds)"
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"authentication_method",
"created",
"display",
"display_url",
"encryption_algorithm",
"group",
"id",
"last_updated",
"name",
"url"
]
},
"IKEProposalRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"authentication_method": {
"enum": [
"preshared-keys",
"certificates",
"rsa-signatures",
"dsa-signatures"
],
"type": "string",
"description": "* `preshared-keys` - Pre-shared keys\n* `certificates` - Certificates\n* `rsa-signatures` - RSA signatures\n* `dsa-signatures` - DSA signatures",
"x-spec-enum-id": "92bb2f1103b3a262"
},
"encryption_algorithm": {
"enum": [
"aes-128-cbc",
"aes-128-gcm",
"aes-192-cbc",
"aes-192-gcm",
"aes-256-cbc",
"aes-256-gcm",
"3des-cbc",
"des-cbc"
],
"type": "string",
"description": "* `aes-128-cbc` - 128-bit AES (CBC)\n* `aes-128-gcm` - 128-bit AES (GCM)\n* `aes-192-cbc` - 192-bit AES (CBC)\n* `aes-192-gcm` - 192-bit AES (GCM)\n* `aes-256-cbc` - 256-bit AES (CBC)\n* `aes-256-gcm` - 256-bit AES (GCM)\n* `3des-cbc` - 3DES\n* `des-cbc` - DES",
"x-spec-enum-id": "b022535cfdee79fe"
},
"authentication_algorithm": {
"enum": [
"hmac-sha1",
"hmac-sha256",
"hmac-sha384",
"hmac-sha512",
"hmac-md5"
],
"type": "string",
"description": "* `hmac-sha1` - SHA-1 HMAC\n* `hmac-sha256` - SHA-256 HMAC\n* `hmac-sha384` - SHA-384 HMAC\n* `hmac-sha512` - SHA-512 HMAC\n* `hmac-md5` - MD5 HMAC",
"x-spec-enum-id": "0830e8839f5dea4f"
},
"group": {
"enum": [
1,
2,
5,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34
],
"type": "integer",
"description": "* `1` - Group 1\n* `2` - Group 2\n* `5` - Group 5\n* `14` - Group 14\n* `15` - Group 15\n* `16` - Group 16\n* `17` - Group 17\n* `18` - Group 18\n* `19` - Group 19\n* `20` - Group 20\n* `21` - Group 21\n* `22` - Group 22\n* `23` - Group 23\n* `24` - Group 24\n* `25` - Group 25\n* `26` - Group 26\n* `27` - Group 27\n* `28` - Group 28\n* `29` - Group 29\n* `30` - Group 30\n* `31` - Group 31\n* `32` - Group 32\n* `33` - Group 33\n* `34` - Group 34",
"x-spec-enum-id": "dbef43be795462a8"
},
"sa_lifetime": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"description": "Security association lifetime (in seconds)"
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"authentication_method",
"encryption_algorithm",
"group",
"name"
]
},
"IPAddress": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"family": {
"type": "object",
"properties": {
"value": {
"enum": [
4,
6
],
"type": "integer",
"description": "* `4` - IPv4\n* `6` - IPv6",
"x-spec-enum-id": "d72003fd1af3603d"
},
"label": {
"type": "string",
"enum": [
"IPv4",
"IPv6"
]
}
},
"readOnly": true
},
"address": {
"type": "string"
},
"vrf": {
"allOf": [
{
"$ref": "#/components/schemas/BriefVRF"
}
],
"nullable": true
},
"tenant": {
"allOf": [
{
"$ref": "#/components/schemas/BriefTenant"
}
],
"nullable": true
},
"status": {
"type": "object",
"properties": {
"value": {
"enum": [
"active",
"reserved",
"deprecated",
"dhcp",
"slaac"
],
"type": "string",
"description": "* `active` - Active\n* `reserved` - Reserved\n* `deprecated` - Deprecated\n* `dhcp` - DHCP\n* `slaac` - SLAAC",
"x-spec-enum-id": "24935cfee15bd268"
},
"label": {
"type": "string",
"enum": [
"Active",
"Reserved",
"Deprecated",
"DHCP",
"SLAAC"
]
}
}
},
"role": {
"type": "object",
"properties": {
"value": {
"enum": [
"loopback",
"secondary",
"anycast",
"vip",
"vrrp",
"hsrp",
"glbp",
"carp",
""
],
"type": "string",
"description": "* `loopback` - Loopback\n* `secondary` - Secondary\n* `anycast` - Anycast\n* `vip` - VIP\n* `vrrp` - VRRP\n* `hsrp` - HSRP\n* `glbp` - GLBP\n* `carp` - CARP",
"x-spec-enum-id": "10fbcb4930889b0f"
},
"label": {
"type": "string",
"enum": [
"Loopback",
"Secondary",
"Anycast",
"VIP",
"VRRP",
"HSRP",
"GLBP",
"CARP"
]
}
}
},
"assigned_object_type": {
"type": "string",
"nullable": true
},
"assigned_object_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64",
"nullable": true
},
"assigned_object": {
"nullable": true,
"readOnly": true
},
"nat_inside": {
"allOf": [
{
"$ref": "#/components/schemas/NestedIPAddress"
}
],
"nullable": true
},
"nat_outside": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedIPAddress"
},
"readOnly": true
},
"dns_name": {
"type": "string",
"description": "Hostname or FQDN (not case-sensitive)",
"pattern": "^([0-9A-Za-z_-]+|\\*)(\\.[0-9A-Za-z_-]+)*\\.?$",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"address",
"assigned_object",
"created",
"display",
"display_url",
"family",
"id",
"last_updated",
"nat_outside",
"url"
]
},
"IPAddressRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"address": {
"type": "string",
"minLength": 1
},
"vrf": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefVRFRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"status": {
"enum": [
"active",
"reserved",
"deprecated",
"dhcp",
"slaac"
],
"type": "string",
"description": "* `active` - Active\n* `reserved` - Reserved\n* `deprecated` - Deprecated\n* `dhcp` - DHCP\n* `slaac` - SLAAC",
"x-spec-enum-id": "24935cfee15bd268"
},
"role": {
"enum": [
"loopback",
"secondary",
"anycast",
"vip",
"vrrp",
"hsrp",
"glbp",
"carp",
""
],
"type": "string",
"description": "* `loopback` - Loopback\n* `secondary` - Secondary\n* `anycast` - Anycast\n* `vip` - VIP\n* `vrrp` - VRRP\n* `hsrp` - HSRP\n* `glbp` - GLBP\n* `carp` - CARP",
"x-spec-enum-id": "10fbcb4930889b0f"
},
"assigned_object_type": {
"type": "string",
"nullable": true
},
"assigned_object_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64",
"nullable": true
},
"nat_inside": {
"allOf": [
{
"$ref": "#/components/schemas/NestedIPAddressRequest"
}
],
"nullable": true
},
"dns_name": {
"type": "string",
"description": "Hostname or FQDN (not case-sensitive)",
"pattern": "^([0-9A-Za-z_-]+|\\*)(\\.[0-9A-Za-z_-]+)*\\.?$",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"address"
]
},
"IPRange": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"family": {
"type": "object",
"properties": {
"value": {
"enum": [
4,
6
],
"type": "integer",
"description": "* `4` - IPv4\n* `6` - IPv6",
"x-spec-enum-id": "d72003fd1af3603d"
},
"label": {
"type": "string",
"enum": [
"IPv4",
"IPv6"
]
}
},
"readOnly": true
},
"start_address": {
"type": "string"
},
"end_address": {
"type": "string"
},
"size": {
"type": "integer",
"readOnly": true
},
"vrf": {
"allOf": [
{
"$ref": "#/components/schemas/BriefVRF"
}
],
"nullable": true
},
"tenant": {
"allOf": [
{
"$ref": "#/components/schemas/BriefTenant"
}
],
"nullable": true
},
"status": {
"type": "object",
"properties": {
"value": {
"enum": [
"active",
"reserved",
"deprecated"
],
"type": "string",
"description": "* `active` - Active\n* `reserved` - Reserved\n* `deprecated` - Deprecated",
"x-spec-enum-id": "6388dfb94ca1cc15"
},
"label": {
"type": "string",
"enum": [
"Active",
"Reserved",
"Deprecated"
]
}
}
},
"role": {
"allOf": [
{
"$ref": "#/components/schemas/BriefRole"
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"mark_populated": {
"type": "boolean",
"description": "Prevent the creation of IP addresses within this range"
},
"mark_utilized": {
"type": "boolean",
"description": "Report space as 100% utilized"
}
},
"required": [
"created",
"display",
"display_url",
"end_address",
"family",
"id",
"last_updated",
"size",
"start_address",
"url"
]
},
"IPRangeRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"start_address": {
"type": "string",
"minLength": 1
},
"end_address": {
"type": "string",
"minLength": 1
},
"vrf": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefVRFRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"status": {
"enum": [
"active",
"reserved",
"deprecated"
],
"type": "string",
"description": "* `active` - Active\n* `reserved` - Reserved\n* `deprecated` - Deprecated",
"x-spec-enum-id": "6388dfb94ca1cc15"
},
"role": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefRoleRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"mark_populated": {
"type": "boolean",
"description": "Prevent the creation of IP addresses within this range"
},
"mark_utilized": {
"type": "boolean",
"description": "Report space as 100% utilized"
}
},
"required": [
"end_address",
"start_address"
]
},
"IPSecPolicy": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"proposals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPSecProposal"
}
},
"pfs_group": {
"type": "object",
"properties": {
"value": {
"enum": [
1,
2,
5,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34
],
"type": "integer",
"description": "* `1` - Group 1\n* `2` - Group 2\n* `5` - Group 5\n* `14` - Group 14\n* `15` - Group 15\n* `16` - Group 16\n* `17` - Group 17\n* `18` - Group 18\n* `19` - Group 19\n* `20` - Group 20\n* `21` - Group 21\n* `22` - Group 22\n* `23` - Group 23\n* `24` - Group 24\n* `25` - Group 25\n* `26` - Group 26\n* `27` - Group 27\n* `28` - Group 28\n* `29` - Group 29\n* `30` - Group 30\n* `31` - Group 31\n* `32` - Group 32\n* `33` - Group 33\n* `34` - Group 34",
"x-spec-enum-id": "dbef43be795462a8"
},
"label": {
"type": "string",
"enum": [
"Group 1",
"Group 2",
"Group 5",
"Group 14",
"Group 15",
"Group 16",
"Group 17",
"Group 18",
"Group 19",
"Group 20",
"Group 21",
"Group 22",
"Group 23",
"Group 24",
"Group 25",
"Group 26",
"Group 27",
"Group 28",
"Group 29",
"Group 30",
"Group 31",
"Group 32",
"Group 33",
"Group 34"
]
}
}
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"created",
"display",
"display_url",
"id",
"last_updated",
"name",
"url"
]
},
"IPSecPolicyRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"proposals": {
"type": "array",
"items": {
"type": "integer"
}
},
"pfs_group": {
"enum": [
1,
2,
5,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34
],
"type": "integer",
"description": "* `1` - Group 1\n* `2` - Group 2\n* `5` - Group 5\n* `14` - Group 14\n* `15` - Group 15\n* `16` - Group 16\n* `17` - Group 17\n* `18` - Group 18\n* `19` - Group 19\n* `20` - Group 20\n* `21` - Group 21\n* `22` - Group 22\n* `23` - Group 23\n* `24` - Group 24\n* `25` - Group 25\n* `26` - Group 26\n* `27` - Group 27\n* `28` - Group 28\n* `29` - Group 29\n* `30` - Group 30\n* `31` - Group 31\n* `32` - Group 32\n* `33` - Group 33\n* `34` - Group 34",
"x-spec-enum-id": "dbef43be795462a8"
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name"
]
},
"IPSecProfile": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"mode": {
"type": "object",
"properties": {
"value": {
"enum": [
"esp",
"ah"
],
"type": "string",
"description": "* `esp` - ESP\n* `ah` - AH",
"x-spec-enum-id": "1136c2cdfee84436"
},
"label": {
"type": "string",
"enum": [
"ESP",
"AH"
]
}
}
},
"ike_policy": {
"$ref": "#/components/schemas/BriefIKEPolicy"
},
"ipsec_policy": {
"$ref": "#/components/schemas/BriefIPSecPolicy"
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"created",
"display",
"display_url",
"id",
"ike_policy",
"ipsec_policy",
"last_updated",
"mode",
"name",
"url"
]
},
"IPSecProfileRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"mode": {
"enum": [
"esp",
"ah"
],
"type": "string",
"description": "* `esp` - ESP\n* `ah` - AH",
"x-spec-enum-id": "1136c2cdfee84436"
},
"ike_policy": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefIKEPolicyRequest"
}
]
},
"ipsec_policy": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefIPSecPolicyRequest"
}
]
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"ike_policy",
"ipsec_policy",
"mode",
"name"
]
},
"IPSecProposal": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"encryption_algorithm": {
"type": "object",
"properties": {
"value": {
"enum": [
"aes-128-cbc",
"aes-128-gcm",
"aes-192-cbc",
"aes-192-gcm",
"aes-256-cbc",
"aes-256-gcm",
"3des-cbc",
"des-cbc"
],
"type": "string",
"description": "* `aes-128-cbc` - 128-bit AES (CBC)\n* `aes-128-gcm` - 128-bit AES (GCM)\n* `aes-192-cbc` - 192-bit AES (CBC)\n* `aes-192-gcm` - 192-bit AES (GCM)\n* `aes-256-cbc` - 256-bit AES (CBC)\n* `aes-256-gcm` - 256-bit AES (GCM)\n* `3des-cbc` - 3DES\n* `des-cbc` - DES",
"x-spec-enum-id": "b022535cfdee79fe"
},
"label": {
"type": "string",
"enum": [
"128-bit AES (CBC)",
"128-bit AES (GCM)",
"192-bit AES (CBC)",
"192-bit AES (GCM)",
"256-bit AES (CBC)",
"256-bit AES (GCM)",
"3DES",
"DES"
]
}
}
},
"authentication_algorithm": {
"type": "object",
"properties": {
"value": {
"enum": [
"hmac-sha1",
"hmac-sha256",
"hmac-sha384",
"hmac-sha512",
"hmac-md5"
],
"type": "string",
"description": "* `hmac-sha1` - SHA-1 HMAC\n* `hmac-sha256` - SHA-256 HMAC\n* `hmac-sha384` - SHA-384 HMAC\n* `hmac-sha512` - SHA-512 HMAC\n* `hmac-md5` - MD5 HMAC",
"x-spec-enum-id": "0830e8839f5dea4f"
},
"label": {
"type": "string",
"enum": [
"SHA-1 HMAC",
"SHA-256 HMAC",
"SHA-384 HMAC",
"SHA-512 HMAC",
"MD5 HMAC"
]
}
}
},
"sa_lifetime_seconds": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"title": "SA lifetime (seconds)",
"description": "Security association lifetime (seconds)"
},
"sa_lifetime_data": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"title": "SA lifetime (KB)",
"description": "Security association lifetime (in kilobytes)"
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"created",
"display",
"display_url",
"id",
"last_updated",
"name",
"url"
]
},
"IPSecProposalRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"encryption_algorithm": {
"enum": [
"aes-128-cbc",
"aes-128-gcm",
"aes-192-cbc",
"aes-192-gcm",
"aes-256-cbc",
"aes-256-gcm",
"3des-cbc",
"des-cbc"
],
"type": "string",
"description": "* `aes-128-cbc` - 128-bit AES (CBC)\n* `aes-128-gcm` - 128-bit AES (GCM)\n* `aes-192-cbc` - 192-bit AES (CBC)\n* `aes-192-gcm` - 192-bit AES (GCM)\n* `aes-256-cbc` - 256-bit AES (CBC)\n* `aes-256-gcm` - 256-bit AES (GCM)\n* `3des-cbc` - 3DES\n* `des-cbc` - DES",
"x-spec-enum-id": "b022535cfdee79fe"
},
"authentication_algorithm": {
"enum": [
"hmac-sha1",
"hmac-sha256",
"hmac-sha384",
"hmac-sha512",
"hmac-md5"
],
"type": "string",
"description": "* `hmac-sha1` - SHA-1 HMAC\n* `hmac-sha256` - SHA-256 HMAC\n* `hmac-sha384` - SHA-384 HMAC\n* `hmac-sha512` - SHA-512 HMAC\n* `hmac-md5` - MD5 HMAC",
"x-spec-enum-id": "0830e8839f5dea4f"
},
"sa_lifetime_seconds": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"title": "SA lifetime (seconds)",
"description": "Security association lifetime (seconds)"
},
"sa_lifetime_data": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"title": "SA lifetime (KB)",
"description": "Security association lifetime (in kilobytes)"
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name"
]
},
"ImageAttachment": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"object_type": {
"type": "string"
},
"object_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64"
},
"parent": {
"nullable": true,
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 50
},
"image": {
"type": "string",
"format": "uri"
},
"description": {
"type": "string",
"maxLength": 200
},
"image_height": {
"type": "integer",
"readOnly": true
},
"image_width": {
"type": "integer",
"readOnly": true
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"created",
"display",
"id",
"image",
"image_height",
"image_width",
"last_updated",
"object_id",
"object_type",
"parent",
"url"
]
},
"ImageAttachmentRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"object_type": {
"type": "string"
},
"object_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64"
},
"name": {
"type": "string",
"maxLength": 50
},
"image": {
"type": "string",
"format": "binary"
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"image",
"object_id",
"object_type"
]
},
"IntegerRange": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer"
},
"minItems": 2,
"maxItems": 2
}
},
"IntegerRangeRequest": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer"
},
"minItems": 2,
"maxItems": 2
}
},
"Interface": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"device": {
"$ref": "#/components/schemas/BriefDevice"
},
"vdcs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualDeviceContext"
}
},
"module": {
"allOf": [
{
"$ref": "#/components/schemas/BriefModule"
}
],
"nullable": true
},
"name": {
"type": "string",
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"type": "object",
"properties": {
"value": {
"enum": [
"virtual",
"bridge",
"lag",
"100base-fx",
"100base-lfx",
"100base-tx",
"100base-t1",
"1000base-t",
"1000base-sx",
"1000base-lx",
"1000base-tx",
"2.5gbase-t",
"5gbase-t",
"10gbase-t",
"10gbase-cx4",
"100base-x-sfp",
"1000base-x-gbic",
"1000base-x-sfp",
"10gbase-x-sfpp",
"10gbase-x-xfp",
"10gbase-x-xenpak",
"10gbase-x-x2",
"25gbase-x-sfp28",
"50gbase-x-sfp56",
"40gbase-x-qsfpp",
"50gbase-x-sfp28",
"100gbase-x-cfp",
"100gbase-x-cfp2",
"200gbase-x-cfp2",
"400gbase-x-cfp2",
"100gbase-x-cfp4",
"100gbase-x-cxp",
"100gbase-x-cpak",
"100gbase-x-dsfp",
"100gbase-x-sfpdd",
"100gbase-x-qsfp28",
"100gbase-x-qsfpdd",
"200gbase-x-qsfp56",
"200gbase-x-qsfpdd",
"400gbase-x-qsfp112",
"400gbase-x-qsfpdd",
"400gbase-x-osfp",
"400gbase-x-osfp-rhs",
"400gbase-x-cdfp",
"400gbase-x-cfp8",
"800gbase-x-qsfpdd",
"800gbase-x-osfp",
"1000base-kx",
"2.5gbase-kx",
"5gbase-kr",
"10gbase-kr",
"10gbase-kx4",
"25gbase-kr",
"40gbase-kr4",
"50gbase-kr",
"100gbase-kp4",
"100gbase-kr2",
"100gbase-kr4",
"ieee802.11a",
"ieee802.11g",
"ieee802.11n",
"ieee802.11ac",
"ieee802.11ad",
"ieee802.11ax",
"ieee802.11ay",
"ieee802.11be",
"ieee802.15.1",
"ieee802.15.4",
"other-wireless",
"gsm",
"cdma",
"lte",
"4g",
"5g",
"sonet-oc3",
"sonet-oc12",
"sonet-oc48",
"sonet-oc192",
"sonet-oc768",
"sonet-oc1920",
"sonet-oc3840",
"1gfc-sfp",
"2gfc-sfp",
"4gfc-sfp",
"8gfc-sfpp",
"16gfc-sfpp",
"32gfc-sfp28",
"32gfc-sfpp",
"64gfc-qsfpp",
"64gfc-sfpdd",
"64gfc-sfpp",
"128gfc-qsfp28",
"infiniband-sdr",
"infiniband-ddr",
"infiniband-qdr",
"infiniband-fdr10",
"infiniband-fdr",
"infiniband-edr",
"infiniband-hdr",
"infiniband-ndr",
"infiniband-xdr",
"t1",
"e1",
"t3",
"e3",
"xdsl",
"docsis",
"moca",
"bpon",
"epon",
"10g-epon",
"gpon",
"xg-pon",
"xgs-pon",
"ng-pon2",
"25g-pon",
"50g-pon",
"cisco-stackwise",
"cisco-stackwise-plus",
"cisco-flexstack",
"cisco-flexstack-plus",
"cisco-stackwise-80",
"cisco-stackwise-160",
"cisco-stackwise-320",
"cisco-stackwise-480",
"cisco-stackwise-1t",
"juniper-vcp",
"extreme-summitstack",
"extreme-summitstack-128",
"extreme-summitstack-256",
"extreme-summitstack-512",
"other"
],
"type": "string",
"description": "* `virtual` - Virtual\n* `bridge` - Bridge\n* `lag` - Link Aggregation Group (LAG)\n* `100base-fx` - 100BASE-FX (10/100ME FIBER)\n* `100base-lfx` - 100BASE-LFX (10/100ME FIBER)\n* `100base-tx` - 100BASE-TX (10/100ME)\n* `100base-t1` - 100BASE-T1 (10/100ME Single Pair)\n* `1000base-t` - 1000BASE-T (1GE)\n* `1000base-sx` - 1000BASE-SX (1GE)\n* `1000base-lx` - 1000BASE-LX (1GE)\n* `1000base-tx` - 1000BASE-TX (1GE)\n* `2.5gbase-t` - 2.5GBASE-T (2.5GE)\n* `5gbase-t` - 5GBASE-T (5GE)\n* `10gbase-t` - 10GBASE-T (10GE)\n* `10gbase-cx4` - 10GBASE-CX4 (10GE)\n* `100base-x-sfp` - SFP (100ME)\n* `1000base-x-gbic` - GBIC (1GE)\n* `1000base-x-sfp` - SFP (1GE)\n* `10gbase-x-sfpp` - SFP+ (10GE)\n* `10gbase-x-xfp` - XFP (10GE)\n* `10gbase-x-xenpak` - XENPAK (10GE)\n* `10gbase-x-x2` - X2 (10GE)\n* `25gbase-x-sfp28` - SFP28 (25GE)\n* `50gbase-x-sfp56` - SFP56 (50GE)\n* `40gbase-x-qsfpp` - QSFP+ (40GE)\n* `50gbase-x-sfp28` - QSFP28 (50GE)\n* `100gbase-x-cfp` - CFP (100GE)\n* `100gbase-x-cfp2` - CFP2 (100GE)\n* `200gbase-x-cfp2` - CFP2 (200GE)\n* `400gbase-x-cfp2` - CFP2 (400GE)\n* `100gbase-x-cfp4` - CFP4 (100GE)\n* `100gbase-x-cxp` - CXP (100GE)\n* `100gbase-x-cpak` - Cisco CPAK (100GE)\n* `100gbase-x-dsfp` - DSFP (100GE)\n* `100gbase-x-sfpdd` - SFP-DD (100GE)\n* `100gbase-x-qsfp28` - QSFP28 (100GE)\n* `100gbase-x-qsfpdd` - QSFP-DD (100GE)\n* `200gbase-x-qsfp56` - QSFP56 (200GE)\n* `200gbase-x-qsfpdd` - QSFP-DD (200GE)\n* `400gbase-x-qsfp112` - QSFP112 (400GE)\n* `400gbase-x-qsfpdd` - QSFP-DD (400GE)\n* `400gbase-x-osfp` - OSFP (400GE)\n* `400gbase-x-osfp-rhs` - OSFP-RHS (400GE)\n* `400gbase-x-cdfp` - CDFP (400GE)\n* `400gbase-x-cfp8` - CPF8 (400GE)\n* `800gbase-x-qsfpdd` - QSFP-DD (800GE)\n* `800gbase-x-osfp` - OSFP (800GE)\n* `1000base-kx` - 1000BASE-KX (1GE)\n* `2.5gbase-kx` - 2.5GBASE-KX (2.5GE)\n* `5gbase-kr` - 5GBASE-KR (5GE)\n* `10gbase-kr` - 10GBASE-KR (10GE)\n* `10gbase-kx4` - 10GBASE-KX4 (10GE)\n* `25gbase-kr` - 25GBASE-KR (25GE)\n* `40gbase-kr4` - 40GBASE-KR4 (40GE)\n* `50gbase-kr` - 50GBASE-KR (50GE)\n* `100gbase-kp4` - 100GBASE-KP4 (100GE)\n* `100gbase-kr2` - 100GBASE-KR2 (100GE)\n* `100gbase-kr4` - 100GBASE-KR4 (100GE)\n* `ieee802.11a` - IEEE 802.11a\n* `ieee802.11g` - IEEE 802.11b/g\n* `ieee802.11n` - IEEE 802.11n\n* `ieee802.11ac` - IEEE 802.11ac\n* `ieee802.11ad` - IEEE 802.11ad\n* `ieee802.11ax` - IEEE 802.11ax\n* `ieee802.11ay` - IEEE 802.11ay\n* `ieee802.11be` - IEEE 802.11be\n* `ieee802.15.1` - IEEE 802.15.1 (Bluetooth)\n* `ieee802.15.4` - IEEE 802.15.4 (LR-WPAN)\n* `other-wireless` - Other (Wireless)\n* `gsm` - GSM\n* `cdma` - CDMA\n* `lte` - LTE\n* `4g` - 4G\n* `5g` - 5G\n* `sonet-oc3` - OC-3/STM-1\n* `sonet-oc12` - OC-12/STM-4\n* `sonet-oc48` - OC-48/STM-16\n* `sonet-oc192` - OC-192/STM-64\n* `sonet-oc768` - OC-768/STM-256\n* `sonet-oc1920` - OC-1920/STM-640\n* `sonet-oc3840` - OC-3840/STM-1234\n* `1gfc-sfp` - SFP (1GFC)\n* `2gfc-sfp` - SFP (2GFC)\n* `4gfc-sfp` - SFP (4GFC)\n* `8gfc-sfpp` - SFP+ (8GFC)\n* `16gfc-sfpp` - SFP+ (16GFC)\n* `32gfc-sfp28` - SFP28 (32GFC)\n* `32gfc-sfpp` - SFP+ (32GFC)\n* `64gfc-qsfpp` - QSFP+ (64GFC)\n* `64gfc-sfpdd` - SFP-DD (64GFC)\n* `64gfc-sfpp` - SFP+ (64GFC)\n* `128gfc-qsfp28` - QSFP28 (128GFC)\n* `infiniband-sdr` - SDR (2 Gbps)\n* `infiniband-ddr` - DDR (4 Gbps)\n* `infiniband-qdr` - QDR (8 Gbps)\n* `infiniband-fdr10` - FDR10 (10 Gbps)\n* `infiniband-fdr` - FDR (13.5 Gbps)\n* `infiniband-edr` - EDR (25 Gbps)\n* `infiniband-hdr` - HDR (50 Gbps)\n* `infiniband-ndr` - NDR (100 Gbps)\n* `infiniband-xdr` - XDR (250 Gbps)\n* `t1` - T1 (1.544 Mbps)\n* `e1` - E1 (2.048 Mbps)\n* `t3` - T3 (45 Mbps)\n* `e3` - E3 (34 Mbps)\n* `xdsl` - xDSL\n* `docsis` - DOCSIS\n* `moca` - MoCA\n* `bpon` - BPON (622 Mbps / 155 Mbps)\n* `epon` - EPON (1 Gbps)\n* `10g-epon` - 10G-EPON (10 Gbps)\n* `gpon` - GPON (2.5 Gbps / 1.25 Gbps)\n* `xg-pon` - XG-PON (10 Gbps / 2.5 Gbps)\n* `xgs-pon` - XGS-PON (10 Gbps)\n* `ng-pon2` - NG-PON2 (TWDM-PON) (4x10 Gbps)\n* `25g-pon` - 25G-PON (25 Gbps)\n* `50g-pon` - 50G-PON (50 Gbps)\n* `cisco-stackwise` - Cisco StackWise\n* `cisco-stackwise-plus` - Cisco StackWise Plus\n* `cisco-flexstack` - Cisco FlexStack\n* `cisco-flexstack-plus` - Cisco FlexStack Plus\n* `cisco-stackwise-80` - Cisco StackWise-80\n* `cisco-stackwise-160` - Cisco StackWise-160\n* `cisco-stackwise-320` - Cisco StackWise-320\n* `cisco-stackwise-480` - Cisco StackWise-480\n* `cisco-stackwise-1t` - Cisco StackWise-1T\n* `juniper-vcp` - Juniper VCP\n* `extreme-summitstack` - Extreme SummitStack\n* `extreme-summitstack-128` - Extreme SummitStack-128\n* `extreme-summitstack-256` - Extreme SummitStack-256\n* `extreme-summitstack-512` - Extreme SummitStack-512\n* `other` - Other",
"x-spec-enum-id": "8c4c5e112f77a383"
},
"label": {
"type": "string",
"enum": [
"Virtual",
"Bridge",
"Link Aggregation Group (LAG)",
"100BASE-FX (10/100ME FIBER)",
"100BASE-LFX (10/100ME FIBER)",
"100BASE-TX (10/100ME)",
"100BASE-T1 (10/100ME Single Pair)",
"1000BASE-T (1GE)",
"1000BASE-SX (1GE)",
"1000BASE-LX (1GE)",
"1000BASE-TX (1GE)",
"2.5GBASE-T (2.5GE)",
"5GBASE-T (5GE)",
"10GBASE-T (10GE)",
"10GBASE-CX4 (10GE)",
"SFP (100ME)",
"GBIC (1GE)",
"SFP (1GE)",
"SFP+ (10GE)",
"XFP (10GE)",
"XENPAK (10GE)",
"X2 (10GE)",
"SFP28 (25GE)",
"SFP56 (50GE)",
"QSFP+ (40GE)",
"QSFP28 (50GE)",
"CFP (100GE)",
"CFP2 (100GE)",
"CFP2 (200GE)",
"CFP2 (400GE)",
"CFP4 (100GE)",
"CXP (100GE)",
"Cisco CPAK (100GE)",
"DSFP (100GE)",
"SFP-DD (100GE)",
"QSFP28 (100GE)",
"QSFP-DD (100GE)",
"QSFP56 (200GE)",
"QSFP-DD (200GE)",
"QSFP112 (400GE)",
"QSFP-DD (400GE)",
"OSFP (400GE)",
"OSFP-RHS (400GE)",
"CDFP (400GE)",
"CPF8 (400GE)",
"QSFP-DD (800GE)",
"OSFP (800GE)",
"1000BASE-KX (1GE)",
"2.5GBASE-KX (2.5GE)",
"5GBASE-KR (5GE)",
"10GBASE-KR (10GE)",
"10GBASE-KX4 (10GE)",
"25GBASE-KR (25GE)",
"40GBASE-KR4 (40GE)",
"50GBASE-KR (50GE)",
"100GBASE-KP4 (100GE)",
"100GBASE-KR2 (100GE)",
"100GBASE-KR4 (100GE)",
"IEEE 802.11a",
"IEEE 802.11b/g",
"IEEE 802.11n",
"IEEE 802.11ac",
"IEEE 802.11ad",
"IEEE 802.11ax",
"IEEE 802.11ay",
"IEEE 802.11be",
"IEEE 802.15.1 (Bluetooth)",
"IEEE 802.15.4 (LR-WPAN)",
"Other (Wireless)",
"GSM",
"CDMA",
"LTE",
"4G",
"5G",
"OC-3/STM-1",
"OC-12/STM-4",
"OC-48/STM-16",
"OC-192/STM-64",
"OC-768/STM-256",
"OC-1920/STM-640",
"OC-3840/STM-1234",
"SFP (1GFC)",
"SFP (2GFC)",
"SFP (4GFC)",
"SFP+ (8GFC)",
"SFP+ (16GFC)",
"SFP28 (32GFC)",
"SFP+ (32GFC)",
"QSFP+ (64GFC)",
"SFP-DD (64GFC)",
"SFP+ (64GFC)",
"QSFP28 (128GFC)",
"SDR (2 Gbps)",
"DDR (4 Gbps)",
"QDR (8 Gbps)",
"FDR10 (10 Gbps)",
"FDR (13.5 Gbps)",
"EDR (25 Gbps)",
"HDR (50 Gbps)",
"NDR (100 Gbps)",
"XDR (250 Gbps)",
"T1 (1.544 Mbps)",
"E1 (2.048 Mbps)",
"T3 (45 Mbps)",
"E3 (34 Mbps)",
"xDSL",
"DOCSIS",
"MoCA",
"BPON (622 Mbps / 155 Mbps)",
"EPON (1 Gbps)",
"10G-EPON (10 Gbps)",
"GPON (2.5 Gbps / 1.25 Gbps)",
"XG-PON (10 Gbps / 2.5 Gbps)",
"XGS-PON (10 Gbps)",
"NG-PON2 (TWDM-PON) (4x10 Gbps)",
"25G-PON (25 Gbps)",
"50G-PON (50 Gbps)",
"Cisco StackWise",
"Cisco StackWise Plus",
"Cisco FlexStack",
"Cisco FlexStack Plus",
"Cisco StackWise-80",
"Cisco StackWise-160",
"Cisco StackWise-320",
"Cisco StackWise-480",
"Cisco StackWise-1T",
"Juniper VCP",
"Extreme SummitStack",
"Extreme SummitStack-128",
"Extreme SummitStack-256",
"Extreme SummitStack-512",
"Other"
]
}
}
},
"enabled": {
"type": "boolean"
},
"parent": {
"allOf": [
{
"$ref": "#/components/schemas/NestedInterface"
}
],
"nullable": true
},
"bridge": {
"allOf": [
{
"$ref": "#/components/schemas/NestedInterface"
}
],
"nullable": true
},
"lag": {
"allOf": [
{
"$ref": "#/components/schemas/NestedInterface"
}
],
"nullable": true
},
"mtu": {
"type": "integer",
"maximum": 65536,
"minimum": 1,
"nullable": true
},
"mac_address": {
"type": "string",
"readOnly": true,
"nullable": true
},
"primary_mac_address": {
"allOf": [
{
"$ref": "#/components/schemas/BriefMACAddress"
}
],
"nullable": true
},
"mac_addresses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BriefMACAddress"
},
"readOnly": true,
"nullable": true
},
"speed": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"title": "Speed (Kbps)"
},
"duplex": {
"type": "object",
"properties": {
"value": {
"enum": [
"half",
"full",
"auto",
"",
null
],
"type": "string",
"description": "* `half` - Half\n* `full` - Full\n* `auto` - Auto",
"x-spec-enum-id": "47eab9b1a65a1e21"
},
"label": {
"type": "string",
"enum": [
"Half",
"Full",
"Auto"
]
}
},
"nullable": true
},
"wwn": {
"type": "string",
"nullable": true
},
"mgmt_only": {
"type": "boolean",
"title": "Management only",
"description": "This interface is used only for out-of-band management"
},
"description": {
"type": "string",
"maxLength": 200
},
"mode": {
"type": "object",
"properties": {
"value": {
"enum": [
"access",
"tagged",
"tagged-all",
"q-in-q",
""
],
"type": "string",
"description": "* `access` - Access\n* `tagged` - Tagged\n* `tagged-all` - Tagged (All)\n* `q-in-q` - Q-in-Q (802.1ad)",
"x-spec-enum-id": "b6fe48fe21dbf01d"
},
"label": {
"type": "string",
"enum": [
"Access",
"Tagged",
"Tagged (All)",
"Q-in-Q (802.1ad)"
]
}
}
},
"rf_role": {
"type": "object",
"properties": {
"value": {
"enum": [
"ap",
"station",
""
],
"type": "string",
"description": "* `ap` - Access point\n* `station` - Station",
"x-spec-enum-id": "d2772dbea88b0fb1"
},
"label": {
"type": "string",
"enum": [
"Access point",
"Station"
]
}
}
},
"rf_channel": {
"type": "object",
"properties": {
"value": {
"enum": [
"2.4g-1-2412-22",
"2.4g-2-2417-22",
"2.4g-3-2422-22",
"2.4g-4-2427-22",
"2.4g-5-2432-22",
"2.4g-6-2437-22",
"2.4g-7-2442-22",
"2.4g-8-2447-22",
"2.4g-9-2452-22",
"2.4g-10-2457-22",
"2.4g-11-2462-22",
"2.4g-12-2467-22",
"2.4g-13-2472-22",
"5g-32-5160-20",
"5g-34-5170-40",
"5g-36-5180-20",
"5g-38-5190-40",
"5g-40-5200-20",
"5g-42-5210-80",
"5g-44-5220-20",
"5g-46-5230-40",
"5g-48-5240-20",
"5g-50-5250-160",
"5g-52-5260-20",
"5g-54-5270-40",
"5g-56-5280-20",
"5g-58-5290-80",
"5g-60-5300-20",
"5g-62-5310-40",
"5g-64-5320-20",
"5g-100-5500-20",
"5g-102-5510-40",
"5g-104-5520-20",
"5g-106-5530-80",
"5g-108-5540-20",
"5g-110-5550-40",
"5g-112-5560-20",
"5g-114-5570-160",
"5g-116-5580-20",
"5g-118-5590-40",
"5g-120-5600-20",
"5g-122-5610-80",
"5g-124-5620-20",
"5g-126-5630-40",
"5g-128-5640-20",
"5g-132-5660-20",
"5g-134-5670-40",
"5g-136-5680-20",
"5g-138-5690-80",
"5g-140-5700-20",
"5g-142-5710-40",
"5g-144-5720-20",
"5g-149-5745-20",
"5g-151-5755-40",
"5g-153-5765-20",
"5g-155-5775-80",
"5g-157-5785-20",
"5g-159-5795-40",
"5g-161-5805-20",
"5g-163-5815-160",
"5g-165-5825-20",
"5g-167-5835-40",
"5g-169-5845-20",
"5g-171-5855-80",
"5g-173-5865-20",
"5g-175-5875-40",
"5g-177-5885-20",
"6g-1-5955-20",
"6g-3-5965-40",
"6g-5-5975-20",
"6g-7-5985-80",
"6g-9-5995-20",
"6g-11-6005-40",
"6g-13-6015-20",
"6g-15-6025-160",
"6g-17-6035-20",
"6g-19-6045-40",
"6g-21-6055-20",
"6g-23-6065-80",
"6g-25-6075-20",
"6g-27-6085-40",
"6g-29-6095-20",
"6g-31-6105-320",
"6g-33-6115-20",
"6g-35-6125-40",
"6g-37-6135-20",
"6g-39-6145-80",
"6g-41-6155-20",
"6g-43-6165-40",
"6g-45-6175-20",
"6g-47-6185-160",
"6g-49-6195-20",
"6g-51-6205-40",
"6g-53-6215-20",
"6g-55-6225-80",
"6g-57-6235-20",
"6g-59-6245-40",
"6g-61-6255-20",
"6g-65-6275-20",
"6g-67-6285-40",
"6g-69-6295-20",
"6g-71-6305-80",
"6g-73-6315-20",
"6g-75-6325-40",
"6g-77-6335-20",
"6g-79-6345-160",
"6g-81-6355-20",
"6g-83-6365-40",
"6g-85-6375-20",
"6g-87-6385-80",
"6g-89-6395-20",
"6g-91-6405-40",
"6g-93-6415-20",
"6g-95-6425-320",
"6g-97-6435-20",
"6g-99-6445-40",
"6g-101-6455-20",
"6g-103-6465-80",
"6g-105-6475-20",
"6g-107-6485-40",
"6g-109-6495-20",
"6g-111-6505-160",
"6g-113-6515-20",
"6g-115-6525-40",
"6g-117-6535-20",
"6g-119-6545-80",
"6g-121-6555-20",
"6g-123-6565-40",
"6g-125-6575-20",
"6g-129-6595-20",
"6g-131-6605-40",
"6g-133-6615-20",
"6g-135-6625-80",
"6g-137-6635-20",
"6g-139-6645-40",
"6g-141-6655-20",
"6g-143-6665-160",
"6g-145-6675-20",
"6g-147-6685-40",
"6g-149-6695-20",
"6g-151-6705-80",
"6g-153-6715-20",
"6g-155-6725-40",
"6g-157-6735-20",
"6g-159-6745-320",
"6g-161-6755-20",
"6g-163-6765-40",
"6g-165-6775-20",
"6g-167-6785-80",
"6g-169-6795-20",
"6g-171-6805-40",
"6g-173-6815-20",
"6g-175-6825-160",
"6g-177-6835-20",
"6g-179-6845-40",
"6g-181-6855-20",
"6g-183-6865-80",
"6g-185-6875-20",
"6g-187-6885-40",
"6g-189-6895-20",
"6g-193-6915-20",
"6g-195-6925-40",
"6g-197-6935-20",
"6g-199-6945-80",
"6g-201-6955-20",
"6g-203-6965-40",
"6g-205-6975-20",
"6g-207-6985-160",
"6g-209-6995-20",
"6g-211-7005-40",
"6g-213-7015-20",
"6g-215-7025-80",
"6g-217-7035-20",
"6g-219-7045-40",
"6g-221-7055-20",
"6g-225-7075-20",
"6g-227-7085-40",
"6g-229-7095-20",
"6g-233-7115-20",
"60g-1-58320-2160",
"60g-2-60480-2160",
"60g-3-62640-2160",
"60g-4-64800-2160",
"60g-5-66960-2160",
"60g-6-69120-2160",
"60g-9-59400-4320",
"60g-10-61560-4320",
"60g-11-63720-4320",
"60g-12-65880-4320",
"60g-13-68040-4320",
"60g-17-60480-6480",
"60g-18-62640-6480",
"60g-19-64800-6480",
"60g-20-66960-6480",
"60g-25-61560-6480",
"60g-26-63720-6480",
"60g-27-65880-6480",
""
],
"type": "string",
"description": "* `2.4g-1-2412-22` - 1 (2412 MHz)\n* `2.4g-2-2417-22` - 2 (2417 MHz)\n* `2.4g-3-2422-22` - 3 (2422 MHz)\n* `2.4g-4-2427-22` - 4 (2427 MHz)\n* `2.4g-5-2432-22` - 5 (2432 MHz)\n* `2.4g-6-2437-22` - 6 (2437 MHz)\n* `2.4g-7-2442-22` - 7 (2442 MHz)\n* `2.4g-8-2447-22` - 8 (2447 MHz)\n* `2.4g-9-2452-22` - 9 (2452 MHz)\n* `2.4g-10-2457-22` - 10 (2457 MHz)\n* `2.4g-11-2462-22` - 11 (2462 MHz)\n* `2.4g-12-2467-22` - 12 (2467 MHz)\n* `2.4g-13-2472-22` - 13 (2472 MHz)\n* `5g-32-5160-20` - 32 (5160/20 MHz)\n* `5g-34-5170-40` - 34 (5170/40 MHz)\n* `5g-36-5180-20` - 36 (5180/20 MHz)\n* `5g-38-5190-40` - 38 (5190/40 MHz)\n* `5g-40-5200-20` - 40 (5200/20 MHz)\n* `5g-42-5210-80` - 42 (5210/80 MHz)\n* `5g-44-5220-20` - 44 (5220/20 MHz)\n* `5g-46-5230-40` - 46 (5230/40 MHz)\n* `5g-48-5240-20` - 48 (5240/20 MHz)\n* `5g-50-5250-160` - 50 (5250/160 MHz)\n* `5g-52-5260-20` - 52 (5260/20 MHz)\n* `5g-54-5270-40` - 54 (5270/40 MHz)\n* `5g-56-5280-20` - 56 (5280/20 MHz)\n* `5g-58-5290-80` - 58 (5290/80 MHz)\n* `5g-60-5300-20` - 60 (5300/20 MHz)\n* `5g-62-5310-40` - 62 (5310/40 MHz)\n* `5g-64-5320-20` - 64 (5320/20 MHz)\n* `5g-100-5500-20` - 100 (5500/20 MHz)\n* `5g-102-5510-40` - 102 (5510/40 MHz)\n* `5g-104-5520-20` - 104 (5520/20 MHz)\n* `5g-106-5530-80` - 106 (5530/80 MHz)\n* `5g-108-5540-20` - 108 (5540/20 MHz)\n* `5g-110-5550-40` - 110 (5550/40 MHz)\n* `5g-112-5560-20` - 112 (5560/20 MHz)\n* `5g-114-5570-160` - 114 (5570/160 MHz)\n* `5g-116-5580-20` - 116 (5580/20 MHz)\n* `5g-118-5590-40` - 118 (5590/40 MHz)\n* `5g-120-5600-20` - 120 (5600/20 MHz)\n* `5g-122-5610-80` - 122 (5610/80 MHz)\n* `5g-124-5620-20` - 124 (5620/20 MHz)\n* `5g-126-5630-40` - 126 (5630/40 MHz)\n* `5g-128-5640-20` - 128 (5640/20 MHz)\n* `5g-132-5660-20` - 132 (5660/20 MHz)\n* `5g-134-5670-40` - 134 (5670/40 MHz)\n* `5g-136-5680-20` - 136 (5680/20 MHz)\n* `5g-138-5690-80` - 138 (5690/80 MHz)\n* `5g-140-5700-20` - 140 (5700/20 MHz)\n* `5g-142-5710-40` - 142 (5710/40 MHz)\n* `5g-144-5720-20` - 144 (5720/20 MHz)\n* `5g-149-5745-20` - 149 (5745/20 MHz)\n* `5g-151-5755-40` - 151 (5755/40 MHz)\n* `5g-153-5765-20` - 153 (5765/20 MHz)\n* `5g-155-5775-80` - 155 (5775/80 MHz)\n* `5g-157-5785-20` - 157 (5785/20 MHz)\n* `5g-159-5795-40` - 159 (5795/40 MHz)\n* `5g-161-5805-20` - 161 (5805/20 MHz)\n* `5g-163-5815-160` - 163 (5815/160 MHz)\n* `5g-165-5825-20` - 165 (5825/20 MHz)\n* `5g-167-5835-40` - 167 (5835/40 MHz)\n* `5g-169-5845-20` - 169 (5845/20 MHz)\n* `5g-171-5855-80` - 171 (5855/80 MHz)\n* `5g-173-5865-20` - 173 (5865/20 MHz)\n* `5g-175-5875-40` - 175 (5875/40 MHz)\n* `5g-177-5885-20` - 177 (5885/20 MHz)\n* `6g-1-5955-20` - 1 (5955/20 MHz)\n* `6g-3-5965-40` - 3 (5965/40 MHz)\n* `6g-5-5975-20` - 5 (5975/20 MHz)\n* `6g-7-5985-80` - 7 (5985/80 MHz)\n* `6g-9-5995-20` - 9 (5995/20 MHz)\n* `6g-11-6005-40` - 11 (6005/40 MHz)\n* `6g-13-6015-20` - 13 (6015/20 MHz)\n* `6g-15-6025-160` - 15 (6025/160 MHz)\n* `6g-17-6035-20` - 17 (6035/20 MHz)\n* `6g-19-6045-40` - 19 (6045/40 MHz)\n* `6g-21-6055-20` - 21 (6055/20 MHz)\n* `6g-23-6065-80` - 23 (6065/80 MHz)\n* `6g-25-6075-20` - 25 (6075/20 MHz)\n* `6g-27-6085-40` - 27 (6085/40 MHz)\n* `6g-29-6095-20` - 29 (6095/20 MHz)\n* `6g-31-6105-320` - 31 (6105/320 MHz)\n* `6g-33-6115-20` - 33 (6115/20 MHz)\n* `6g-35-6125-40` - 35 (6125/40 MHz)\n* `6g-37-6135-20` - 37 (6135/20 MHz)\n* `6g-39-6145-80` - 39 (6145/80 MHz)\n* `6g-41-6155-20` - 41 (6155/20 MHz)\n* `6g-43-6165-40` - 43 (6165/40 MHz)\n* `6g-45-6175-20` - 45 (6175/20 MHz)\n* `6g-47-6185-160` - 47 (6185/160 MHz)\n* `6g-49-6195-20` - 49 (6195/20 MHz)\n* `6g-51-6205-40` - 51 (6205/40 MHz)\n* `6g-53-6215-20` - 53 (6215/20 MHz)\n* `6g-55-6225-80` - 55 (6225/80 MHz)\n* `6g-57-6235-20` - 57 (6235/20 MHz)\n* `6g-59-6245-40` - 59 (6245/40 MHz)\n* `6g-61-6255-20` - 61 (6255/20 MHz)\n* `6g-65-6275-20` - 65 (6275/20 MHz)\n* `6g-67-6285-40` - 67 (6285/40 MHz)\n* `6g-69-6295-20` - 69 (6295/20 MHz)\n* `6g-71-6305-80` - 71 (6305/80 MHz)\n* `6g-73-6315-20` - 73 (6315/20 MHz)\n* `6g-75-6325-40` - 75 (6325/40 MHz)\n* `6g-77-6335-20` - 77 (6335/20 MHz)\n* `6g-79-6345-160` - 79 (6345/160 MHz)\n* `6g-81-6355-20` - 81 (6355/20 MHz)\n* `6g-83-6365-40` - 83 (6365/40 MHz)\n* `6g-85-6375-20` - 85 (6375/20 MHz)\n* `6g-87-6385-80` - 87 (6385/80 MHz)\n* `6g-89-6395-20` - 89 (6395/20 MHz)\n* `6g-91-6405-40` - 91 (6405/40 MHz)\n* `6g-93-6415-20` - 93 (6415/20 MHz)\n* `6g-95-6425-320` - 95 (6425/320 MHz)\n* `6g-97-6435-20` - 97 (6435/20 MHz)\n* `6g-99-6445-40` - 99 (6445/40 MHz)\n* `6g-101-6455-20` - 101 (6455/20 MHz)\n* `6g-103-6465-80` - 103 (6465/80 MHz)\n* `6g-105-6475-20` - 105 (6475/20 MHz)\n* `6g-107-6485-40` - 107 (6485/40 MHz)\n* `6g-109-6495-20` - 109 (6495/20 MHz)\n* `6g-111-6505-160` - 111 (6505/160 MHz)\n* `6g-113-6515-20` - 113 (6515/20 MHz)\n* `6g-115-6525-40` - 115 (6525/40 MHz)\n* `6g-117-6535-20` - 117 (6535/20 MHz)\n* `6g-119-6545-80` - 119 (6545/80 MHz)\n* `6g-121-6555-20` - 121 (6555/20 MHz)\n* `6g-123-6565-40` - 123 (6565/40 MHz)\n* `6g-125-6575-20` - 125 (6575/20 MHz)\n* `6g-129-6595-20` - 129 (6595/20 MHz)\n* `6g-131-6605-40` - 131 (6605/40 MHz)\n* `6g-133-6615-20` - 133 (6615/20 MHz)\n* `6g-135-6625-80` - 135 (6625/80 MHz)\n* `6g-137-6635-20` - 137 (6635/20 MHz)\n* `6g-139-6645-40` - 139 (6645/40 MHz)\n* `6g-141-6655-20` - 141 (6655/20 MHz)\n* `6g-143-6665-160` - 143 (6665/160 MHz)\n* `6g-145-6675-20` - 145 (6675/20 MHz)\n* `6g-147-6685-40` - 147 (6685/40 MHz)\n* `6g-149-6695-20` - 149 (6695/20 MHz)\n* `6g-151-6705-80` - 151 (6705/80 MHz)\n* `6g-153-6715-20` - 153 (6715/20 MHz)\n* `6g-155-6725-40` - 155 (6725/40 MHz)\n* `6g-157-6735-20` - 157 (6735/20 MHz)\n* `6g-159-6745-320` - 159 (6745/320 MHz)\n* `6g-161-6755-20` - 161 (6755/20 MHz)\n* `6g-163-6765-40` - 163 (6765/40 MHz)\n* `6g-165-6775-20` - 165 (6775/20 MHz)\n* `6g-167-6785-80` - 167 (6785/80 MHz)\n* `6g-169-6795-20` - 169 (6795/20 MHz)\n* `6g-171-6805-40` - 171 (6805/40 MHz)\n* `6g-173-6815-20` - 173 (6815/20 MHz)\n* `6g-175-6825-160` - 175 (6825/160 MHz)\n* `6g-177-6835-20` - 177 (6835/20 MHz)\n* `6g-179-6845-40` - 179 (6845/40 MHz)\n* `6g-181-6855-20` - 181 (6855/20 MHz)\n* `6g-183-6865-80` - 183 (6865/80 MHz)\n* `6g-185-6875-20` - 185 (6875/20 MHz)\n* `6g-187-6885-40` - 187 (6885/40 MHz)\n* `6g-189-6895-20` - 189 (6895/20 MHz)\n* `6g-193-6915-20` - 193 (6915/20 MHz)\n* `6g-195-6925-40` - 195 (6925/40 MHz)\n* `6g-197-6935-20` - 197 (6935/20 MHz)\n* `6g-199-6945-80` - 199 (6945/80 MHz)\n* `6g-201-6955-20` - 201 (6955/20 MHz)\n* `6g-203-6965-40` - 203 (6965/40 MHz)\n* `6g-205-6975-20` - 205 (6975/20 MHz)\n* `6g-207-6985-160` - 207 (6985/160 MHz)\n* `6g-209-6995-20` - 209 (6995/20 MHz)\n* `6g-211-7005-40` - 211 (7005/40 MHz)\n* `6g-213-7015-20` - 213 (7015/20 MHz)\n* `6g-215-7025-80` - 215 (7025/80 MHz)\n* `6g-217-7035-20` - 217 (7035/20 MHz)\n* `6g-219-7045-40` - 219 (7045/40 MHz)\n* `6g-221-7055-20` - 221 (7055/20 MHz)\n* `6g-225-7075-20` - 225 (7075/20 MHz)\n* `6g-227-7085-40` - 227 (7085/40 MHz)\n* `6g-229-7095-20` - 229 (7095/20 MHz)\n* `6g-233-7115-20` - 233 (7115/20 MHz)\n* `60g-1-58320-2160` - 1 (58.32/2.16 GHz)\n* `60g-2-60480-2160` - 2 (60.48/2.16 GHz)\n* `60g-3-62640-2160` - 3 (62.64/2.16 GHz)\n* `60g-4-64800-2160` - 4 (64.80/2.16 GHz)\n* `60g-5-66960-2160` - 5 (66.96/2.16 GHz)\n* `60g-6-69120-2160` - 6 (69.12/2.16 GHz)\n* `60g-9-59400-4320` - 9 (59.40/4.32 GHz)\n* `60g-10-61560-4320` - 10 (61.56/4.32 GHz)\n* `60g-11-63720-4320` - 11 (63.72/4.32 GHz)\n* `60g-12-65880-4320` - 12 (65.88/4.32 GHz)\n* `60g-13-68040-4320` - 13 (68.04/4.32 GHz)\n* `60g-17-60480-6480` - 17 (60.48/6.48 GHz)\n* `60g-18-62640-6480` - 18 (62.64/6.48 GHz)\n* `60g-19-64800-6480` - 19 (64.80/6.48 GHz)\n* `60g-20-66960-6480` - 20 (66.96/6.48 GHz)\n* `60g-25-61560-6480` - 25 (61.56/8.64 GHz)\n* `60g-26-63720-6480` - 26 (63.72/8.64 GHz)\n* `60g-27-65880-6480` - 27 (65.88/8.64 GHz)",
"x-spec-enum-id": "aac33cc237adc8f9"
},
"label": {
"type": "string",
"enum": [
"1 (2412 MHz)",
"2 (2417 MHz)",
"3 (2422 MHz)",
"4 (2427 MHz)",
"5 (2432 MHz)",
"6 (2437 MHz)",
"7 (2442 MHz)",
"8 (2447 MHz)",
"9 (2452 MHz)",
"10 (2457 MHz)",
"11 (2462 MHz)",
"12 (2467 MHz)",
"13 (2472 MHz)",
"32 (5160/20 MHz)",
"34 (5170/40 MHz)",
"36 (5180/20 MHz)",
"38 (5190/40 MHz)",
"40 (5200/20 MHz)",
"42 (5210/80 MHz)",
"44 (5220/20 MHz)",
"46 (5230/40 MHz)",
"48 (5240/20 MHz)",
"50 (5250/160 MHz)",
"52 (5260/20 MHz)",
"54 (5270/40 MHz)",
"56 (5280/20 MHz)",
"58 (5290/80 MHz)",
"60 (5300/20 MHz)",
"62 (5310/40 MHz)",
"64 (5320/20 MHz)",
"100 (5500/20 MHz)",
"102 (5510/40 MHz)",
"104 (5520/20 MHz)",
"106 (5530/80 MHz)",
"108 (5540/20 MHz)",
"110 (5550/40 MHz)",
"112 (5560/20 MHz)",
"114 (5570/160 MHz)",
"116 (5580/20 MHz)",
"118 (5590/40 MHz)",
"120 (5600/20 MHz)",
"122 (5610/80 MHz)",
"124 (5620/20 MHz)",
"126 (5630/40 MHz)",
"128 (5640/20 MHz)",
"132 (5660/20 MHz)",
"134 (5670/40 MHz)",
"136 (5680/20 MHz)",
"138 (5690/80 MHz)",
"140 (5700/20 MHz)",
"142 (5710/40 MHz)",
"144 (5720/20 MHz)",
"149 (5745/20 MHz)",
"151 (5755/40 MHz)",
"153 (5765/20 MHz)",
"155 (5775/80 MHz)",
"157 (5785/20 MHz)",
"159 (5795/40 MHz)",
"161 (5805/20 MHz)",
"163 (5815/160 MHz)",
"165 (5825/20 MHz)",
"167 (5835/40 MHz)",
"169 (5845/20 MHz)",
"171 (5855/80 MHz)",
"173 (5865/20 MHz)",
"175 (5875/40 MHz)",
"177 (5885/20 MHz)",
"1 (5955/20 MHz)",
"3 (5965/40 MHz)",
"5 (5975/20 MHz)",
"7 (5985/80 MHz)",
"9 (5995/20 MHz)",
"11 (6005/40 MHz)",
"13 (6015/20 MHz)",
"15 (6025/160 MHz)",
"17 (6035/20 MHz)",
"19 (6045/40 MHz)",
"21 (6055/20 MHz)",
"23 (6065/80 MHz)",
"25 (6075/20 MHz)",
"27 (6085/40 MHz)",
"29 (6095/20 MHz)",
"31 (6105/320 MHz)",
"33 (6115/20 MHz)",
"35 (6125/40 MHz)",
"37 (6135/20 MHz)",
"39 (6145/80 MHz)",
"41 (6155/20 MHz)",
"43 (6165/40 MHz)",
"45 (6175/20 MHz)",
"47 (6185/160 MHz)",
"49 (6195/20 MHz)",
"51 (6205/40 MHz)",
"53 (6215/20 MHz)",
"55 (6225/80 MHz)",
"57 (6235/20 MHz)",
"59 (6245/40 MHz)",
"61 (6255/20 MHz)",
"65 (6275/20 MHz)",
"67 (6285/40 MHz)",
"69 (6295/20 MHz)",
"71 (6305/80 MHz)",
"73 (6315/20 MHz)",
"75 (6325/40 MHz)",
"77 (6335/20 MHz)",
"79 (6345/160 MHz)",
"81 (6355/20 MHz)",
"83 (6365/40 MHz)",
"85 (6375/20 MHz)",
"87 (6385/80 MHz)",
"89 (6395/20 MHz)",
"91 (6405/40 MHz)",
"93 (6415/20 MHz)",
"95 (6425/320 MHz)",
"97 (6435/20 MHz)",
"99 (6445/40 MHz)",
"101 (6455/20 MHz)",
"103 (6465/80 MHz)",
"105 (6475/20 MHz)",
"107 (6485/40 MHz)",
"109 (6495/20 MHz)",
"111 (6505/160 MHz)",
"113 (6515/20 MHz)",
"115 (6525/40 MHz)",
"117 (6535/20 MHz)",
"119 (6545/80 MHz)",
"121 (6555/20 MHz)",
"123 (6565/40 MHz)",
"125 (6575/20 MHz)",
"129 (6595/20 MHz)",
"131 (6605/40 MHz)",
"133 (6615/20 MHz)",
"135 (6625/80 MHz)",
"137 (6635/20 MHz)",
"139 (6645/40 MHz)",
"141 (6655/20 MHz)",
"143 (6665/160 MHz)",
"145 (6675/20 MHz)",
"147 (6685/40 MHz)",
"149 (6695/20 MHz)",
"151 (6705/80 MHz)",
"153 (6715/20 MHz)",
"155 (6725/40 MHz)",
"157 (6735/20 MHz)",
"159 (6745/320 MHz)",
"161 (6755/20 MHz)",
"163 (6765/40 MHz)",
"165 (6775/20 MHz)",
"167 (6785/80 MHz)",
"169 (6795/20 MHz)",
"171 (6805/40 MHz)",
"173 (6815/20 MHz)",
"175 (6825/160 MHz)",
"177 (6835/20 MHz)",
"179 (6845/40 MHz)",
"181 (6855/20 MHz)",
"183 (6865/80 MHz)",
"185 (6875/20 MHz)",
"187 (6885/40 MHz)",
"189 (6895/20 MHz)",
"193 (6915/20 MHz)",
"195 (6925/40 MHz)",
"197 (6935/20 MHz)",
"199 (6945/80 MHz)",
"201 (6955/20 MHz)",
"203 (6965/40 MHz)",
"205 (6975/20 MHz)",
"207 (6985/160 MHz)",
"209 (6995/20 MHz)",
"211 (7005/40 MHz)",
"213 (7015/20 MHz)",
"215 (7025/80 MHz)",
"217 (7035/20 MHz)",
"219 (7045/40 MHz)",
"221 (7055/20 MHz)",
"225 (7075/20 MHz)",
"227 (7085/40 MHz)",
"229 (7095/20 MHz)",
"233 (7115/20 MHz)",
"1 (58.32/2.16 GHz)",
"2 (60.48/2.16 GHz)",
"3 (62.64/2.16 GHz)",
"4 (64.80/2.16 GHz)",
"5 (66.96/2.16 GHz)",
"6 (69.12/2.16 GHz)",
"9 (59.40/4.32 GHz)",
"10 (61.56/4.32 GHz)",
"11 (63.72/4.32 GHz)",
"12 (65.88/4.32 GHz)",
"13 (68.04/4.32 GHz)",
"17 (60.48/6.48 GHz)",
"18 (62.64/6.48 GHz)",
"19 (64.80/6.48 GHz)",
"20 (66.96/6.48 GHz)",
"25 (61.56/8.64 GHz)",
"26 (63.72/8.64 GHz)",
"27 (65.88/8.64 GHz)"
]
}
}
},
"poe_mode": {
"type": "object",
"properties": {
"value": {
"enum": [
"pd",
"pse",
""
],
"type": "string",
"description": "* `pd` - PD\n* `pse` - PSE",
"x-spec-enum-id": "2f2fe6dcdc7772bd"
},
"label": {
"type": "string",
"enum": [
"PD",
"PSE"
]
}
}
},
"poe_type": {
"type": "object",
"properties": {
"value": {
"enum": [
"type1-ieee802.3af",
"type2-ieee802.3at",
"type3-ieee802.3bt",
"type4-ieee802.3bt",
"passive-24v-2pair",
"passive-24v-4pair",
"passive-48v-2pair",
"passive-48v-4pair",
""
],
"type": "string",
"description": "* `type1-ieee802.3af` - 802.3af (Type 1)\n* `type2-ieee802.3at` - 802.3at (Type 2)\n* `type3-ieee802.3bt` - 802.3bt (Type 3)\n* `type4-ieee802.3bt` - 802.3bt (Type 4)\n* `passive-24v-2pair` - Passive 24V (2-pair)\n* `passive-24v-4pair` - Passive 24V (4-pair)\n* `passive-48v-2pair` - Passive 48V (2-pair)\n* `passive-48v-4pair` - Passive 48V (4-pair)",
"x-spec-enum-id": "74bd3be4012f6da9"
},
"label": {
"type": "string",
"enum": [
"802.3af (Type 1)",
"802.3at (Type 2)",
"802.3bt (Type 3)",
"802.3bt (Type 4)",
"Passive 24V (2-pair)",
"Passive 24V (4-pair)",
"Passive 48V (2-pair)",
"Passive 48V (4-pair)"
]
}
}
},
"rf_channel_frequency": {
"type": "number",
"format": "double",
"maximum": 100000,
"minimum": -100000,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true,
"title": "Channel frequency (MHz)",
"description": "Populated by selected channel (if set)"
},
"rf_channel_width": {
"type": "number",
"format": "double",
"maximum": 10000,
"minimum": -10000,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true,
"title": "Channel width (MHz)",
"description": "Populated by selected channel (if set)"
},
"tx_power": {
"type": "integer",
"maximum": 127,
"minimum": -40,
"nullable": true,
"title": "Transmit power (dBm)"
},
"untagged_vlan": {
"allOf": [
{
"$ref": "#/components/schemas/BriefVLAN"
}
],
"nullable": true
},
"tagged_vlans": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VLAN"
}
},
"qinq_svlan": {
"allOf": [
{
"$ref": "#/components/schemas/BriefVLAN"
}
],
"nullable": true
},
"vlan_translation_policy": {
"allOf": [
{
"$ref": "#/components/schemas/BriefVLANTranslationPolicy"
}
],
"nullable": true
},
"mark_connected": {
"type": "boolean",
"description": "Treat as if a cable is connected"
},
"cable": {
"allOf": [
{
"$ref": "#/components/schemas/BriefCable"
}
],
"readOnly": true,
"nullable": true
},
"cable_end": {
"type": "string",
"readOnly": true
},
"wireless_link": {
"allOf": [
{
"$ref": "#/components/schemas/NestedWirelessLink"
}
],
"readOnly": true,
"nullable": true
},
"link_peers": {
"type": "array",
"items": {},
"readOnly": true
},
"link_peers_type": {
"type": "string",
"description": "Return the type of the peer link terminations, or None.",
"readOnly": true,
"nullable": true
},
"wireless_lans": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WirelessLAN"
}
},
"vrf": {
"allOf": [
{
"$ref": "#/components/schemas/BriefVRF"
}
],
"nullable": true
},
"l2vpn_termination": {
"allOf": [
{
"$ref": "#/components/schemas/BriefL2VPNTermination"
}
],
"readOnly": true,
"nullable": true
},
"connected_endpoints": {
"type": "array",
"items": {},
"nullable": true,
"readOnly": true
},
"connected_endpoints_type": {
"type": "string",
"readOnly": true,
"nullable": true
},
"connected_endpoints_reachable": {
"type": "boolean",
"readOnly": true
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"count_ipaddresses": {
"type": "integer",
"readOnly": true
},
"count_fhrp_groups": {
"type": "integer",
"readOnly": true
},
"_occupied": {
"type": "boolean",
"readOnly": true,
"title": " occupied"
}
},
"required": [
"_occupied",
"cable",
"cable_end",
"connected_endpoints",
"connected_endpoints_reachable",
"connected_endpoints_type",
"count_fhrp_groups",
"count_ipaddresses",
"created",
"device",
"display",
"display_url",
"id",
"l2vpn_termination",
"last_updated",
"link_peers",
"link_peers_type",
"mac_address",
"mac_addresses",
"name",
"type",
"url",
"wireless_link"
]
},
"InterfaceRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"device": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDeviceRequest"
}
]
},
"vdcs": {
"type": "array",
"items": {
"type": "integer"
}
},
"module": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"enum": [
"virtual",
"bridge",
"lag",
"100base-fx",
"100base-lfx",
"100base-tx",
"100base-t1",
"1000base-t",
"1000base-sx",
"1000base-lx",
"1000base-tx",
"2.5gbase-t",
"5gbase-t",
"10gbase-t",
"10gbase-cx4",
"100base-x-sfp",
"1000base-x-gbic",
"1000base-x-sfp",
"10gbase-x-sfpp",
"10gbase-x-xfp",
"10gbase-x-xenpak",
"10gbase-x-x2",
"25gbase-x-sfp28",
"50gbase-x-sfp56",
"40gbase-x-qsfpp",
"50gbase-x-sfp28",
"100gbase-x-cfp",
"100gbase-x-cfp2",
"200gbase-x-cfp2",
"400gbase-x-cfp2",
"100gbase-x-cfp4",
"100gbase-x-cxp",
"100gbase-x-cpak",
"100gbase-x-dsfp",
"100gbase-x-sfpdd",
"100gbase-x-qsfp28",
"100gbase-x-qsfpdd",
"200gbase-x-qsfp56",
"200gbase-x-qsfpdd",
"400gbase-x-qsfp112",
"400gbase-x-qsfpdd",
"400gbase-x-osfp",
"400gbase-x-osfp-rhs",
"400gbase-x-cdfp",
"400gbase-x-cfp8",
"800gbase-x-qsfpdd",
"800gbase-x-osfp",
"1000base-kx",
"2.5gbase-kx",
"5gbase-kr",
"10gbase-kr",
"10gbase-kx4",
"25gbase-kr",
"40gbase-kr4",
"50gbase-kr",
"100gbase-kp4",
"100gbase-kr2",
"100gbase-kr4",
"ieee802.11a",
"ieee802.11g",
"ieee802.11n",
"ieee802.11ac",
"ieee802.11ad",
"ieee802.11ax",
"ieee802.11ay",
"ieee802.11be",
"ieee802.15.1",
"ieee802.15.4",
"other-wireless",
"gsm",
"cdma",
"lte",
"4g",
"5g",
"sonet-oc3",
"sonet-oc12",
"sonet-oc48",
"sonet-oc192",
"sonet-oc768",
"sonet-oc1920",
"sonet-oc3840",
"1gfc-sfp",
"2gfc-sfp",
"4gfc-sfp",
"8gfc-sfpp",
"16gfc-sfpp",
"32gfc-sfp28",
"32gfc-sfpp",
"64gfc-qsfpp",
"64gfc-sfpdd",
"64gfc-sfpp",
"128gfc-qsfp28",
"infiniband-sdr",
"infiniband-ddr",
"infiniband-qdr",
"infiniband-fdr10",
"infiniband-fdr",
"infiniband-edr",
"infiniband-hdr",
"infiniband-ndr",
"infiniband-xdr",
"t1",
"e1",
"t3",
"e3",
"xdsl",
"docsis",
"moca",
"bpon",
"epon",
"10g-epon",
"gpon",
"xg-pon",
"xgs-pon",
"ng-pon2",
"25g-pon",
"50g-pon",
"cisco-stackwise",
"cisco-stackwise-plus",
"cisco-flexstack",
"cisco-flexstack-plus",
"cisco-stackwise-80",
"cisco-stackwise-160",
"cisco-stackwise-320",
"cisco-stackwise-480",
"cisco-stackwise-1t",
"juniper-vcp",
"extreme-summitstack",
"extreme-summitstack-128",
"extreme-summitstack-256",
"extreme-summitstack-512",
"other"
],
"type": "string",
"description": "* `virtual` - Virtual\n* `bridge` - Bridge\n* `lag` - Link Aggregation Group (LAG)\n* `100base-fx` - 100BASE-FX (10/100ME FIBER)\n* `100base-lfx` - 100BASE-LFX (10/100ME FIBER)\n* `100base-tx` - 100BASE-TX (10/100ME)\n* `100base-t1` - 100BASE-T1 (10/100ME Single Pair)\n* `1000base-t` - 1000BASE-T (1GE)\n* `1000base-sx` - 1000BASE-SX (1GE)\n* `1000base-lx` - 1000BASE-LX (1GE)\n* `1000base-tx` - 1000BASE-TX (1GE)\n* `2.5gbase-t` - 2.5GBASE-T (2.5GE)\n* `5gbase-t` - 5GBASE-T (5GE)\n* `10gbase-t` - 10GBASE-T (10GE)\n* `10gbase-cx4` - 10GBASE-CX4 (10GE)\n* `100base-x-sfp` - SFP (100ME)\n* `1000base-x-gbic` - GBIC (1GE)\n* `1000base-x-sfp` - SFP (1GE)\n* `10gbase-x-sfpp` - SFP+ (10GE)\n* `10gbase-x-xfp` - XFP (10GE)\n* `10gbase-x-xenpak` - XENPAK (10GE)\n* `10gbase-x-x2` - X2 (10GE)\n* `25gbase-x-sfp28` - SFP28 (25GE)\n* `50gbase-x-sfp56` - SFP56 (50GE)\n* `40gbase-x-qsfpp` - QSFP+ (40GE)\n* `50gbase-x-sfp28` - QSFP28 (50GE)\n* `100gbase-x-cfp` - CFP (100GE)\n* `100gbase-x-cfp2` - CFP2 (100GE)\n* `200gbase-x-cfp2` - CFP2 (200GE)\n* `400gbase-x-cfp2` - CFP2 (400GE)\n* `100gbase-x-cfp4` - CFP4 (100GE)\n* `100gbase-x-cxp` - CXP (100GE)\n* `100gbase-x-cpak` - Cisco CPAK (100GE)\n* `100gbase-x-dsfp` - DSFP (100GE)\n* `100gbase-x-sfpdd` - SFP-DD (100GE)\n* `100gbase-x-qsfp28` - QSFP28 (100GE)\n* `100gbase-x-qsfpdd` - QSFP-DD (100GE)\n* `200gbase-x-qsfp56` - QSFP56 (200GE)\n* `200gbase-x-qsfpdd` - QSFP-DD (200GE)\n* `400gbase-x-qsfp112` - QSFP112 (400GE)\n* `400gbase-x-qsfpdd` - QSFP-DD (400GE)\n* `400gbase-x-osfp` - OSFP (400GE)\n* `400gbase-x-osfp-rhs` - OSFP-RHS (400GE)\n* `400gbase-x-cdfp` - CDFP (400GE)\n* `400gbase-x-cfp8` - CPF8 (400GE)\n* `800gbase-x-qsfpdd` - QSFP-DD (800GE)\n* `800gbase-x-osfp` - OSFP (800GE)\n* `1000base-kx` - 1000BASE-KX (1GE)\n* `2.5gbase-kx` - 2.5GBASE-KX (2.5GE)\n* `5gbase-kr` - 5GBASE-KR (5GE)\n* `10gbase-kr` - 10GBASE-KR (10GE)\n* `10gbase-kx4` - 10GBASE-KX4 (10GE)\n* `25gbase-kr` - 25GBASE-KR (25GE)\n* `40gbase-kr4` - 40GBASE-KR4 (40GE)\n* `50gbase-kr` - 50GBASE-KR (50GE)\n* `100gbase-kp4` - 100GBASE-KP4 (100GE)\n* `100gbase-kr2` - 100GBASE-KR2 (100GE)\n* `100gbase-kr4` - 100GBASE-KR4 (100GE)\n* `ieee802.11a` - IEEE 802.11a\n* `ieee802.11g` - IEEE 802.11b/g\n* `ieee802.11n` - IEEE 802.11n\n* `ieee802.11ac` - IEEE 802.11ac\n* `ieee802.11ad` - IEEE 802.11ad\n* `ieee802.11ax` - IEEE 802.11ax\n* `ieee802.11ay` - IEEE 802.11ay\n* `ieee802.11be` - IEEE 802.11be\n* `ieee802.15.1` - IEEE 802.15.1 (Bluetooth)\n* `ieee802.15.4` - IEEE 802.15.4 (LR-WPAN)\n* `other-wireless` - Other (Wireless)\n* `gsm` - GSM\n* `cdma` - CDMA\n* `lte` - LTE\n* `4g` - 4G\n* `5g` - 5G\n* `sonet-oc3` - OC-3/STM-1\n* `sonet-oc12` - OC-12/STM-4\n* `sonet-oc48` - OC-48/STM-16\n* `sonet-oc192` - OC-192/STM-64\n* `sonet-oc768` - OC-768/STM-256\n* `sonet-oc1920` - OC-1920/STM-640\n* `sonet-oc3840` - OC-3840/STM-1234\n* `1gfc-sfp` - SFP (1GFC)\n* `2gfc-sfp` - SFP (2GFC)\n* `4gfc-sfp` - SFP (4GFC)\n* `8gfc-sfpp` - SFP+ (8GFC)\n* `16gfc-sfpp` - SFP+ (16GFC)\n* `32gfc-sfp28` - SFP28 (32GFC)\n* `32gfc-sfpp` - SFP+ (32GFC)\n* `64gfc-qsfpp` - QSFP+ (64GFC)\n* `64gfc-sfpdd` - SFP-DD (64GFC)\n* `64gfc-sfpp` - SFP+ (64GFC)\n* `128gfc-qsfp28` - QSFP28 (128GFC)\n* `infiniband-sdr` - SDR (2 Gbps)\n* `infiniband-ddr` - DDR (4 Gbps)\n* `infiniband-qdr` - QDR (8 Gbps)\n* `infiniband-fdr10` - FDR10 (10 Gbps)\n* `infiniband-fdr` - FDR (13.5 Gbps)\n* `infiniband-edr` - EDR (25 Gbps)\n* `infiniband-hdr` - HDR (50 Gbps)\n* `infiniband-ndr` - NDR (100 Gbps)\n* `infiniband-xdr` - XDR (250 Gbps)\n* `t1` - T1 (1.544 Mbps)\n* `e1` - E1 (2.048 Mbps)\n* `t3` - T3 (45 Mbps)\n* `e3` - E3 (34 Mbps)\n* `xdsl` - xDSL\n* `docsis` - DOCSIS\n* `moca` - MoCA\n* `bpon` - BPON (622 Mbps / 155 Mbps)\n* `epon` - EPON (1 Gbps)\n* `10g-epon` - 10G-EPON (10 Gbps)\n* `gpon` - GPON (2.5 Gbps / 1.25 Gbps)\n* `xg-pon` - XG-PON (10 Gbps / 2.5 Gbps)\n* `xgs-pon` - XGS-PON (10 Gbps)\n* `ng-pon2` - NG-PON2 (TWDM-PON) (4x10 Gbps)\n* `25g-pon` - 25G-PON (25 Gbps)\n* `50g-pon` - 50G-PON (50 Gbps)\n* `cisco-stackwise` - Cisco StackWise\n* `cisco-stackwise-plus` - Cisco StackWise Plus\n* `cisco-flexstack` - Cisco FlexStack\n* `cisco-flexstack-plus` - Cisco FlexStack Plus\n* `cisco-stackwise-80` - Cisco StackWise-80\n* `cisco-stackwise-160` - Cisco StackWise-160\n* `cisco-stackwise-320` - Cisco StackWise-320\n* `cisco-stackwise-480` - Cisco StackWise-480\n* `cisco-stackwise-1t` - Cisco StackWise-1T\n* `juniper-vcp` - Juniper VCP\n* `extreme-summitstack` - Extreme SummitStack\n* `extreme-summitstack-128` - Extreme SummitStack-128\n* `extreme-summitstack-256` - Extreme SummitStack-256\n* `extreme-summitstack-512` - Extreme SummitStack-512\n* `other` - Other",
"x-spec-enum-id": "8c4c5e112f77a383"
},
"enabled": {
"type": "boolean"
},
"parent": {
"allOf": [
{
"$ref": "#/components/schemas/NestedInterfaceRequest"
}
],
"nullable": true
},
"bridge": {
"allOf": [
{
"$ref": "#/components/schemas/NestedInterfaceRequest"
}
],
"nullable": true
},
"lag": {
"allOf": [
{
"$ref": "#/components/schemas/NestedInterfaceRequest"
}
],
"nullable": true
},
"mtu": {
"type": "integer",
"maximum": 65536,
"minimum": 1,
"nullable": true
},
"primary_mac_address": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefMACAddressRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"speed": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"title": "Speed (Kbps)"
},
"duplex": {
"enum": [
"half",
"full",
"auto",
"",
null
],
"type": "string",
"description": "* `half` - Half\n* `full` - Full\n* `auto` - Auto",
"x-spec-enum-id": "47eab9b1a65a1e21",
"nullable": true
},
"wwn": {
"type": "string",
"nullable": true
},
"mgmt_only": {
"type": "boolean",
"title": "Management only",
"description": "This interface is used only for out-of-band management"
},
"description": {
"type": "string",
"maxLength": 200
},
"mode": {
"enum": [
"access",
"tagged",
"tagged-all",
"q-in-q",
""
],
"type": "string",
"description": "* `access` - Access\n* `tagged` - Tagged\n* `tagged-all` - Tagged (All)\n* `q-in-q` - Q-in-Q (802.1ad)",
"x-spec-enum-id": "b6fe48fe21dbf01d"
},
"rf_role": {
"enum": [
"ap",
"station",
""
],
"type": "string",
"description": "* `ap` - Access point\n* `station` - Station",
"x-spec-enum-id": "d2772dbea88b0fb1"
},
"rf_channel": {
"enum": [
"2.4g-1-2412-22",
"2.4g-2-2417-22",
"2.4g-3-2422-22",
"2.4g-4-2427-22",
"2.4g-5-2432-22",
"2.4g-6-2437-22",
"2.4g-7-2442-22",
"2.4g-8-2447-22",
"2.4g-9-2452-22",
"2.4g-10-2457-22",
"2.4g-11-2462-22",
"2.4g-12-2467-22",
"2.4g-13-2472-22",
"5g-32-5160-20",
"5g-34-5170-40",
"5g-36-5180-20",
"5g-38-5190-40",
"5g-40-5200-20",
"5g-42-5210-80",
"5g-44-5220-20",
"5g-46-5230-40",
"5g-48-5240-20",
"5g-50-5250-160",
"5g-52-5260-20",
"5g-54-5270-40",
"5g-56-5280-20",
"5g-58-5290-80",
"5g-60-5300-20",
"5g-62-5310-40",
"5g-64-5320-20",
"5g-100-5500-20",
"5g-102-5510-40",
"5g-104-5520-20",
"5g-106-5530-80",
"5g-108-5540-20",
"5g-110-5550-40",
"5g-112-5560-20",
"5g-114-5570-160",
"5g-116-5580-20",
"5g-118-5590-40",
"5g-120-5600-20",
"5g-122-5610-80",
"5g-124-5620-20",
"5g-126-5630-40",
"5g-128-5640-20",
"5g-132-5660-20",
"5g-134-5670-40",
"5g-136-5680-20",
"5g-138-5690-80",
"5g-140-5700-20",
"5g-142-5710-40",
"5g-144-5720-20",
"5g-149-5745-20",
"5g-151-5755-40",
"5g-153-5765-20",
"5g-155-5775-80",
"5g-157-5785-20",
"5g-159-5795-40",
"5g-161-5805-20",
"5g-163-5815-160",
"5g-165-5825-20",
"5g-167-5835-40",
"5g-169-5845-20",
"5g-171-5855-80",
"5g-173-5865-20",
"5g-175-5875-40",
"5g-177-5885-20",
"6g-1-5955-20",
"6g-3-5965-40",
"6g-5-5975-20",
"6g-7-5985-80",
"6g-9-5995-20",
"6g-11-6005-40",
"6g-13-6015-20",
"6g-15-6025-160",
"6g-17-6035-20",
"6g-19-6045-40",
"6g-21-6055-20",
"6g-23-6065-80",
"6g-25-6075-20",
"6g-27-6085-40",
"6g-29-6095-20",
"6g-31-6105-320",
"6g-33-6115-20",
"6g-35-6125-40",
"6g-37-6135-20",
"6g-39-6145-80",
"6g-41-6155-20",
"6g-43-6165-40",
"6g-45-6175-20",
"6g-47-6185-160",
"6g-49-6195-20",
"6g-51-6205-40",
"6g-53-6215-20",
"6g-55-6225-80",
"6g-57-6235-20",
"6g-59-6245-40",
"6g-61-6255-20",
"6g-65-6275-20",
"6g-67-6285-40",
"6g-69-6295-20",
"6g-71-6305-80",
"6g-73-6315-20",
"6g-75-6325-40",
"6g-77-6335-20",
"6g-79-6345-160",
"6g-81-6355-20",
"6g-83-6365-40",
"6g-85-6375-20",
"6g-87-6385-80",
"6g-89-6395-20",
"6g-91-6405-40",
"6g-93-6415-20",
"6g-95-6425-320",
"6g-97-6435-20",
"6g-99-6445-40",
"6g-101-6455-20",
"6g-103-6465-80",
"6g-105-6475-20",
"6g-107-6485-40",
"6g-109-6495-20",
"6g-111-6505-160",
"6g-113-6515-20",
"6g-115-6525-40",
"6g-117-6535-20",
"6g-119-6545-80",
"6g-121-6555-20",
"6g-123-6565-40",
"6g-125-6575-20",
"6g-129-6595-20",
"6g-131-6605-40",
"6g-133-6615-20",
"6g-135-6625-80",
"6g-137-6635-20",
"6g-139-6645-40",
"6g-141-6655-20",
"6g-143-6665-160",
"6g-145-6675-20",
"6g-147-6685-40",
"6g-149-6695-20",
"6g-151-6705-80",
"6g-153-6715-20",
"6g-155-6725-40",
"6g-157-6735-20",
"6g-159-6745-320",
"6g-161-6755-20",
"6g-163-6765-40",
"6g-165-6775-20",
"6g-167-6785-80",
"6g-169-6795-20",
"6g-171-6805-40",
"6g-173-6815-20",
"6g-175-6825-160",
"6g-177-6835-20",
"6g-179-6845-40",
"6g-181-6855-20",
"6g-183-6865-80",
"6g-185-6875-20",
"6g-187-6885-40",
"6g-189-6895-20",
"6g-193-6915-20",
"6g-195-6925-40",
"6g-197-6935-20",
"6g-199-6945-80",
"6g-201-6955-20",
"6g-203-6965-40",
"6g-205-6975-20",
"6g-207-6985-160",
"6g-209-6995-20",
"6g-211-7005-40",
"6g-213-7015-20",
"6g-215-7025-80",
"6g-217-7035-20",
"6g-219-7045-40",
"6g-221-7055-20",
"6g-225-7075-20",
"6g-227-7085-40",
"6g-229-7095-20",
"6g-233-7115-20",
"60g-1-58320-2160",
"60g-2-60480-2160",
"60g-3-62640-2160",
"60g-4-64800-2160",
"60g-5-66960-2160",
"60g-6-69120-2160",
"60g-9-59400-4320",
"60g-10-61560-4320",
"60g-11-63720-4320",
"60g-12-65880-4320",
"60g-13-68040-4320",
"60g-17-60480-6480",
"60g-18-62640-6480",
"60g-19-64800-6480",
"60g-20-66960-6480",
"60g-25-61560-6480",
"60g-26-63720-6480",
"60g-27-65880-6480",
""
],
"type": "string",
"description": "* `2.4g-1-2412-22` - 1 (2412 MHz)\n* `2.4g-2-2417-22` - 2 (2417 MHz)\n* `2.4g-3-2422-22` - 3 (2422 MHz)\n* `2.4g-4-2427-22` - 4 (2427 MHz)\n* `2.4g-5-2432-22` - 5 (2432 MHz)\n* `2.4g-6-2437-22` - 6 (2437 MHz)\n* `2.4g-7-2442-22` - 7 (2442 MHz)\n* `2.4g-8-2447-22` - 8 (2447 MHz)\n* `2.4g-9-2452-22` - 9 (2452 MHz)\n* `2.4g-10-2457-22` - 10 (2457 MHz)\n* `2.4g-11-2462-22` - 11 (2462 MHz)\n* `2.4g-12-2467-22` - 12 (2467 MHz)\n* `2.4g-13-2472-22` - 13 (2472 MHz)\n* `5g-32-5160-20` - 32 (5160/20 MHz)\n* `5g-34-5170-40` - 34 (5170/40 MHz)\n* `5g-36-5180-20` - 36 (5180/20 MHz)\n* `5g-38-5190-40` - 38 (5190/40 MHz)\n* `5g-40-5200-20` - 40 (5200/20 MHz)\n* `5g-42-5210-80` - 42 (5210/80 MHz)\n* `5g-44-5220-20` - 44 (5220/20 MHz)\n* `5g-46-5230-40` - 46 (5230/40 MHz)\n* `5g-48-5240-20` - 48 (5240/20 MHz)\n* `5g-50-5250-160` - 50 (5250/160 MHz)\n* `5g-52-5260-20` - 52 (5260/20 MHz)\n* `5g-54-5270-40` - 54 (5270/40 MHz)\n* `5g-56-5280-20` - 56 (5280/20 MHz)\n* `5g-58-5290-80` - 58 (5290/80 MHz)\n* `5g-60-5300-20` - 60 (5300/20 MHz)\n* `5g-62-5310-40` - 62 (5310/40 MHz)\n* `5g-64-5320-20` - 64 (5320/20 MHz)\n* `5g-100-5500-20` - 100 (5500/20 MHz)\n* `5g-102-5510-40` - 102 (5510/40 MHz)\n* `5g-104-5520-20` - 104 (5520/20 MHz)\n* `5g-106-5530-80` - 106 (5530/80 MHz)\n* `5g-108-5540-20` - 108 (5540/20 MHz)\n* `5g-110-5550-40` - 110 (5550/40 MHz)\n* `5g-112-5560-20` - 112 (5560/20 MHz)\n* `5g-114-5570-160` - 114 (5570/160 MHz)\n* `5g-116-5580-20` - 116 (5580/20 MHz)\n* `5g-118-5590-40` - 118 (5590/40 MHz)\n* `5g-120-5600-20` - 120 (5600/20 MHz)\n* `5g-122-5610-80` - 122 (5610/80 MHz)\n* `5g-124-5620-20` - 124 (5620/20 MHz)\n* `5g-126-5630-40` - 126 (5630/40 MHz)\n* `5g-128-5640-20` - 128 (5640/20 MHz)\n* `5g-132-5660-20` - 132 (5660/20 MHz)\n* `5g-134-5670-40` - 134 (5670/40 MHz)\n* `5g-136-5680-20` - 136 (5680/20 MHz)\n* `5g-138-5690-80` - 138 (5690/80 MHz)\n* `5g-140-5700-20` - 140 (5700/20 MHz)\n* `5g-142-5710-40` - 142 (5710/40 MHz)\n* `5g-144-5720-20` - 144 (5720/20 MHz)\n* `5g-149-5745-20` - 149 (5745/20 MHz)\n* `5g-151-5755-40` - 151 (5755/40 MHz)\n* `5g-153-5765-20` - 153 (5765/20 MHz)\n* `5g-155-5775-80` - 155 (5775/80 MHz)\n* `5g-157-5785-20` - 157 (5785/20 MHz)\n* `5g-159-5795-40` - 159 (5795/40 MHz)\n* `5g-161-5805-20` - 161 (5805/20 MHz)\n* `5g-163-5815-160` - 163 (5815/160 MHz)\n* `5g-165-5825-20` - 165 (5825/20 MHz)\n* `5g-167-5835-40` - 167 (5835/40 MHz)\n* `5g-169-5845-20` - 169 (5845/20 MHz)\n* `5g-171-5855-80` - 171 (5855/80 MHz)\n* `5g-173-5865-20` - 173 (5865/20 MHz)\n* `5g-175-5875-40` - 175 (5875/40 MHz)\n* `5g-177-5885-20` - 177 (5885/20 MHz)\n* `6g-1-5955-20` - 1 (5955/20 MHz)\n* `6g-3-5965-40` - 3 (5965/40 MHz)\n* `6g-5-5975-20` - 5 (5975/20 MHz)\n* `6g-7-5985-80` - 7 (5985/80 MHz)\n* `6g-9-5995-20` - 9 (5995/20 MHz)\n* `6g-11-6005-40` - 11 (6005/40 MHz)\n* `6g-13-6015-20` - 13 (6015/20 MHz)\n* `6g-15-6025-160` - 15 (6025/160 MHz)\n* `6g-17-6035-20` - 17 (6035/20 MHz)\n* `6g-19-6045-40` - 19 (6045/40 MHz)\n* `6g-21-6055-20` - 21 (6055/20 MHz)\n* `6g-23-6065-80` - 23 (6065/80 MHz)\n* `6g-25-6075-20` - 25 (6075/20 MHz)\n* `6g-27-6085-40` - 27 (6085/40 MHz)\n* `6g-29-6095-20` - 29 (6095/20 MHz)\n* `6g-31-6105-320` - 31 (6105/320 MHz)\n* `6g-33-6115-20` - 33 (6115/20 MHz)\n* `6g-35-6125-40` - 35 (6125/40 MHz)\n* `6g-37-6135-20` - 37 (6135/20 MHz)\n* `6g-39-6145-80` - 39 (6145/80 MHz)\n* `6g-41-6155-20` - 41 (6155/20 MHz)\n* `6g-43-6165-40` - 43 (6165/40 MHz)\n* `6g-45-6175-20` - 45 (6175/20 MHz)\n* `6g-47-6185-160` - 47 (6185/160 MHz)\n* `6g-49-6195-20` - 49 (6195/20 MHz)\n* `6g-51-6205-40` - 51 (6205/40 MHz)\n* `6g-53-6215-20` - 53 (6215/20 MHz)\n* `6g-55-6225-80` - 55 (6225/80 MHz)\n* `6g-57-6235-20` - 57 (6235/20 MHz)\n* `6g-59-6245-40` - 59 (6245/40 MHz)\n* `6g-61-6255-20` - 61 (6255/20 MHz)\n* `6g-65-6275-20` - 65 (6275/20 MHz)\n* `6g-67-6285-40` - 67 (6285/40 MHz)\n* `6g-69-6295-20` - 69 (6295/20 MHz)\n* `6g-71-6305-80` - 71 (6305/80 MHz)\n* `6g-73-6315-20` - 73 (6315/20 MHz)\n* `6g-75-6325-40` - 75 (6325/40 MHz)\n* `6g-77-6335-20` - 77 (6335/20 MHz)\n* `6g-79-6345-160` - 79 (6345/160 MHz)\n* `6g-81-6355-20` - 81 (6355/20 MHz)\n* `6g-83-6365-40` - 83 (6365/40 MHz)\n* `6g-85-6375-20` - 85 (6375/20 MHz)\n* `6g-87-6385-80` - 87 (6385/80 MHz)\n* `6g-89-6395-20` - 89 (6395/20 MHz)\n* `6g-91-6405-40` - 91 (6405/40 MHz)\n* `6g-93-6415-20` - 93 (6415/20 MHz)\n* `6g-95-6425-320` - 95 (6425/320 MHz)\n* `6g-97-6435-20` - 97 (6435/20 MHz)\n* `6g-99-6445-40` - 99 (6445/40 MHz)\n* `6g-101-6455-20` - 101 (6455/20 MHz)\n* `6g-103-6465-80` - 103 (6465/80 MHz)\n* `6g-105-6475-20` - 105 (6475/20 MHz)\n* `6g-107-6485-40` - 107 (6485/40 MHz)\n* `6g-109-6495-20` - 109 (6495/20 MHz)\n* `6g-111-6505-160` - 111 (6505/160 MHz)\n* `6g-113-6515-20` - 113 (6515/20 MHz)\n* `6g-115-6525-40` - 115 (6525/40 MHz)\n* `6g-117-6535-20` - 117 (6535/20 MHz)\n* `6g-119-6545-80` - 119 (6545/80 MHz)\n* `6g-121-6555-20` - 121 (6555/20 MHz)\n* `6g-123-6565-40` - 123 (6565/40 MHz)\n* `6g-125-6575-20` - 125 (6575/20 MHz)\n* `6g-129-6595-20` - 129 (6595/20 MHz)\n* `6g-131-6605-40` - 131 (6605/40 MHz)\n* `6g-133-6615-20` - 133 (6615/20 MHz)\n* `6g-135-6625-80` - 135 (6625/80 MHz)\n* `6g-137-6635-20` - 137 (6635/20 MHz)\n* `6g-139-6645-40` - 139 (6645/40 MHz)\n* `6g-141-6655-20` - 141 (6655/20 MHz)\n* `6g-143-6665-160` - 143 (6665/160 MHz)\n* `6g-145-6675-20` - 145 (6675/20 MHz)\n* `6g-147-6685-40` - 147 (6685/40 MHz)\n* `6g-149-6695-20` - 149 (6695/20 MHz)\n* `6g-151-6705-80` - 151 (6705/80 MHz)\n* `6g-153-6715-20` - 153 (6715/20 MHz)\n* `6g-155-6725-40` - 155 (6725/40 MHz)\n* `6g-157-6735-20` - 157 (6735/20 MHz)\n* `6g-159-6745-320` - 159 (6745/320 MHz)\n* `6g-161-6755-20` - 161 (6755/20 MHz)\n* `6g-163-6765-40` - 163 (6765/40 MHz)\n* `6g-165-6775-20` - 165 (6775/20 MHz)\n* `6g-167-6785-80` - 167 (6785/80 MHz)\n* `6g-169-6795-20` - 169 (6795/20 MHz)\n* `6g-171-6805-40` - 171 (6805/40 MHz)\n* `6g-173-6815-20` - 173 (6815/20 MHz)\n* `6g-175-6825-160` - 175 (6825/160 MHz)\n* `6g-177-6835-20` - 177 (6835/20 MHz)\n* `6g-179-6845-40` - 179 (6845/40 MHz)\n* `6g-181-6855-20` - 181 (6855/20 MHz)\n* `6g-183-6865-80` - 183 (6865/80 MHz)\n* `6g-185-6875-20` - 185 (6875/20 MHz)\n* `6g-187-6885-40` - 187 (6885/40 MHz)\n* `6g-189-6895-20` - 189 (6895/20 MHz)\n* `6g-193-6915-20` - 193 (6915/20 MHz)\n* `6g-195-6925-40` - 195 (6925/40 MHz)\n* `6g-197-6935-20` - 197 (6935/20 MHz)\n* `6g-199-6945-80` - 199 (6945/80 MHz)\n* `6g-201-6955-20` - 201 (6955/20 MHz)\n* `6g-203-6965-40` - 203 (6965/40 MHz)\n* `6g-205-6975-20` - 205 (6975/20 MHz)\n* `6g-207-6985-160` - 207 (6985/160 MHz)\n* `6g-209-6995-20` - 209 (6995/20 MHz)\n* `6g-211-7005-40` - 211 (7005/40 MHz)\n* `6g-213-7015-20` - 213 (7015/20 MHz)\n* `6g-215-7025-80` - 215 (7025/80 MHz)\n* `6g-217-7035-20` - 217 (7035/20 MHz)\n* `6g-219-7045-40` - 219 (7045/40 MHz)\n* `6g-221-7055-20` - 221 (7055/20 MHz)\n* `6g-225-7075-20` - 225 (7075/20 MHz)\n* `6g-227-7085-40` - 227 (7085/40 MHz)\n* `6g-229-7095-20` - 229 (7095/20 MHz)\n* `6g-233-7115-20` - 233 (7115/20 MHz)\n* `60g-1-58320-2160` - 1 (58.32/2.16 GHz)\n* `60g-2-60480-2160` - 2 (60.48/2.16 GHz)\n* `60g-3-62640-2160` - 3 (62.64/2.16 GHz)\n* `60g-4-64800-2160` - 4 (64.80/2.16 GHz)\n* `60g-5-66960-2160` - 5 (66.96/2.16 GHz)\n* `60g-6-69120-2160` - 6 (69.12/2.16 GHz)\n* `60g-9-59400-4320` - 9 (59.40/4.32 GHz)\n* `60g-10-61560-4320` - 10 (61.56/4.32 GHz)\n* `60g-11-63720-4320` - 11 (63.72/4.32 GHz)\n* `60g-12-65880-4320` - 12 (65.88/4.32 GHz)\n* `60g-13-68040-4320` - 13 (68.04/4.32 GHz)\n* `60g-17-60480-6480` - 17 (60.48/6.48 GHz)\n* `60g-18-62640-6480` - 18 (62.64/6.48 GHz)\n* `60g-19-64800-6480` - 19 (64.80/6.48 GHz)\n* `60g-20-66960-6480` - 20 (66.96/6.48 GHz)\n* `60g-25-61560-6480` - 25 (61.56/8.64 GHz)\n* `60g-26-63720-6480` - 26 (63.72/8.64 GHz)\n* `60g-27-65880-6480` - 27 (65.88/8.64 GHz)",
"x-spec-enum-id": "aac33cc237adc8f9"
},
"poe_mode": {
"enum": [
"pd",
"pse",
""
],
"type": "string",
"description": "* `pd` - PD\n* `pse` - PSE",
"x-spec-enum-id": "2f2fe6dcdc7772bd"
},
"poe_type": {
"enum": [
"type1-ieee802.3af",
"type2-ieee802.3at",
"type3-ieee802.3bt",
"type4-ieee802.3bt",
"passive-24v-2pair",
"passive-24v-4pair",
"passive-48v-2pair",
"passive-48v-4pair",
""
],
"type": "string",
"description": "* `type1-ieee802.3af` - 802.3af (Type 1)\n* `type2-ieee802.3at` - 802.3at (Type 2)\n* `type3-ieee802.3bt` - 802.3bt (Type 3)\n* `type4-ieee802.3bt` - 802.3bt (Type 4)\n* `passive-24v-2pair` - Passive 24V (2-pair)\n* `passive-24v-4pair` - Passive 24V (4-pair)\n* `passive-48v-2pair` - Passive 48V (2-pair)\n* `passive-48v-4pair` - Passive 48V (4-pair)",
"x-spec-enum-id": "74bd3be4012f6da9"
},
"rf_channel_frequency": {
"type": "number",
"format": "double",
"maximum": 100000,
"minimum": -100000,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true,
"title": "Channel frequency (MHz)",
"description": "Populated by selected channel (if set)"
},
"rf_channel_width": {
"type": "number",
"format": "double",
"maximum": 10000,
"minimum": -10000,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true,
"title": "Channel width (MHz)",
"description": "Populated by selected channel (if set)"
},
"tx_power": {
"type": "integer",
"maximum": 127,
"minimum": -40,
"nullable": true,
"title": "Transmit power (dBm)"
},
"untagged_vlan": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefVLANRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"tagged_vlans": {
"type": "array",
"items": {
"type": "integer"
}
},
"qinq_svlan": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefVLANRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"vlan_translation_policy": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefVLANTranslationPolicyRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"mark_connected": {
"type": "boolean",
"description": "Treat as if a cable is connected"
},
"wireless_lans": {
"type": "array",
"items": {
"type": "integer"
}
},
"vrf": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefVRFRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"device",
"name",
"type"
]
},
"InterfaceTemplate": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"device_type": {
"allOf": [
{
"$ref": "#/components/schemas/BriefDeviceType"
}
],
"nullable": true
},
"module_type": {
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleType"
}
],
"nullable": true
},
"name": {
"type": "string",
"description": "{module} is accepted as a substitution for the module bay position when attached to a module type.",
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"type": "object",
"properties": {
"value": {
"enum": [
"virtual",
"bridge",
"lag",
"100base-fx",
"100base-lfx",
"100base-tx",
"100base-t1",
"1000base-t",
"1000base-sx",
"1000base-lx",
"1000base-tx",
"2.5gbase-t",
"5gbase-t",
"10gbase-t",
"10gbase-cx4",
"100base-x-sfp",
"1000base-x-gbic",
"1000base-x-sfp",
"10gbase-x-sfpp",
"10gbase-x-xfp",
"10gbase-x-xenpak",
"10gbase-x-x2",
"25gbase-x-sfp28",
"50gbase-x-sfp56",
"40gbase-x-qsfpp",
"50gbase-x-sfp28",
"100gbase-x-cfp",
"100gbase-x-cfp2",
"200gbase-x-cfp2",
"400gbase-x-cfp2",
"100gbase-x-cfp4",
"100gbase-x-cxp",
"100gbase-x-cpak",
"100gbase-x-dsfp",
"100gbase-x-sfpdd",
"100gbase-x-qsfp28",
"100gbase-x-qsfpdd",
"200gbase-x-qsfp56",
"200gbase-x-qsfpdd",
"400gbase-x-qsfp112",
"400gbase-x-qsfpdd",
"400gbase-x-osfp",
"400gbase-x-osfp-rhs",
"400gbase-x-cdfp",
"400gbase-x-cfp8",
"800gbase-x-qsfpdd",
"800gbase-x-osfp",
"1000base-kx",
"2.5gbase-kx",
"5gbase-kr",
"10gbase-kr",
"10gbase-kx4",
"25gbase-kr",
"40gbase-kr4",
"50gbase-kr",
"100gbase-kp4",
"100gbase-kr2",
"100gbase-kr4",
"ieee802.11a",
"ieee802.11g",
"ieee802.11n",
"ieee802.11ac",
"ieee802.11ad",
"ieee802.11ax",
"ieee802.11ay",
"ieee802.11be",
"ieee802.15.1",
"ieee802.15.4",
"other-wireless",
"gsm",
"cdma",
"lte",
"4g",
"5g",
"sonet-oc3",
"sonet-oc12",
"sonet-oc48",
"sonet-oc192",
"sonet-oc768",
"sonet-oc1920",
"sonet-oc3840",
"1gfc-sfp",
"2gfc-sfp",
"4gfc-sfp",
"8gfc-sfpp",
"16gfc-sfpp",
"32gfc-sfp28",
"32gfc-sfpp",
"64gfc-qsfpp",
"64gfc-sfpdd",
"64gfc-sfpp",
"128gfc-qsfp28",
"infiniband-sdr",
"infiniband-ddr",
"infiniband-qdr",
"infiniband-fdr10",
"infiniband-fdr",
"infiniband-edr",
"infiniband-hdr",
"infiniband-ndr",
"infiniband-xdr",
"t1",
"e1",
"t3",
"e3",
"xdsl",
"docsis",
"moca",
"bpon",
"epon",
"10g-epon",
"gpon",
"xg-pon",
"xgs-pon",
"ng-pon2",
"25g-pon",
"50g-pon",
"cisco-stackwise",
"cisco-stackwise-plus",
"cisco-flexstack",
"cisco-flexstack-plus",
"cisco-stackwise-80",
"cisco-stackwise-160",
"cisco-stackwise-320",
"cisco-stackwise-480",
"cisco-stackwise-1t",
"juniper-vcp",
"extreme-summitstack",
"extreme-summitstack-128",
"extreme-summitstack-256",
"extreme-summitstack-512",
"other"
],
"type": "string",
"description": "* `virtual` - Virtual\n* `bridge` - Bridge\n* `lag` - Link Aggregation Group (LAG)\n* `100base-fx` - 100BASE-FX (10/100ME FIBER)\n* `100base-lfx` - 100BASE-LFX (10/100ME FIBER)\n* `100base-tx` - 100BASE-TX (10/100ME)\n* `100base-t1` - 100BASE-T1 (10/100ME Single Pair)\n* `1000base-t` - 1000BASE-T (1GE)\n* `1000base-sx` - 1000BASE-SX (1GE)\n* `1000base-lx` - 1000BASE-LX (1GE)\n* `1000base-tx` - 1000BASE-TX (1GE)\n* `2.5gbase-t` - 2.5GBASE-T (2.5GE)\n* `5gbase-t` - 5GBASE-T (5GE)\n* `10gbase-t` - 10GBASE-T (10GE)\n* `10gbase-cx4` - 10GBASE-CX4 (10GE)\n* `100base-x-sfp` - SFP (100ME)\n* `1000base-x-gbic` - GBIC (1GE)\n* `1000base-x-sfp` - SFP (1GE)\n* `10gbase-x-sfpp` - SFP+ (10GE)\n* `10gbase-x-xfp` - XFP (10GE)\n* `10gbase-x-xenpak` - XENPAK (10GE)\n* `10gbase-x-x2` - X2 (10GE)\n* `25gbase-x-sfp28` - SFP28 (25GE)\n* `50gbase-x-sfp56` - SFP56 (50GE)\n* `40gbase-x-qsfpp` - QSFP+ (40GE)\n* `50gbase-x-sfp28` - QSFP28 (50GE)\n* `100gbase-x-cfp` - CFP (100GE)\n* `100gbase-x-cfp2` - CFP2 (100GE)\n* `200gbase-x-cfp2` - CFP2 (200GE)\n* `400gbase-x-cfp2` - CFP2 (400GE)\n* `100gbase-x-cfp4` - CFP4 (100GE)\n* `100gbase-x-cxp` - CXP (100GE)\n* `100gbase-x-cpak` - Cisco CPAK (100GE)\n* `100gbase-x-dsfp` - DSFP (100GE)\n* `100gbase-x-sfpdd` - SFP-DD (100GE)\n* `100gbase-x-qsfp28` - QSFP28 (100GE)\n* `100gbase-x-qsfpdd` - QSFP-DD (100GE)\n* `200gbase-x-qsfp56` - QSFP56 (200GE)\n* `200gbase-x-qsfpdd` - QSFP-DD (200GE)\n* `400gbase-x-qsfp112` - QSFP112 (400GE)\n* `400gbase-x-qsfpdd` - QSFP-DD (400GE)\n* `400gbase-x-osfp` - OSFP (400GE)\n* `400gbase-x-osfp-rhs` - OSFP-RHS (400GE)\n* `400gbase-x-cdfp` - CDFP (400GE)\n* `400gbase-x-cfp8` - CPF8 (400GE)\n* `800gbase-x-qsfpdd` - QSFP-DD (800GE)\n* `800gbase-x-osfp` - OSFP (800GE)\n* `1000base-kx` - 1000BASE-KX (1GE)\n* `2.5gbase-kx` - 2.5GBASE-KX (2.5GE)\n* `5gbase-kr` - 5GBASE-KR (5GE)\n* `10gbase-kr` - 10GBASE-KR (10GE)\n* `10gbase-kx4` - 10GBASE-KX4 (10GE)\n* `25gbase-kr` - 25GBASE-KR (25GE)\n* `40gbase-kr4` - 40GBASE-KR4 (40GE)\n* `50gbase-kr` - 50GBASE-KR (50GE)\n* `100gbase-kp4` - 100GBASE-KP4 (100GE)\n* `100gbase-kr2` - 100GBASE-KR2 (100GE)\n* `100gbase-kr4` - 100GBASE-KR4 (100GE)\n* `ieee802.11a` - IEEE 802.11a\n* `ieee802.11g` - IEEE 802.11b/g\n* `ieee802.11n` - IEEE 802.11n\n* `ieee802.11ac` - IEEE 802.11ac\n* `ieee802.11ad` - IEEE 802.11ad\n* `ieee802.11ax` - IEEE 802.11ax\n* `ieee802.11ay` - IEEE 802.11ay\n* `ieee802.11be` - IEEE 802.11be\n* `ieee802.15.1` - IEEE 802.15.1 (Bluetooth)\n* `ieee802.15.4` - IEEE 802.15.4 (LR-WPAN)\n* `other-wireless` - Other (Wireless)\n* `gsm` - GSM\n* `cdma` - CDMA\n* `lte` - LTE\n* `4g` - 4G\n* `5g` - 5G\n* `sonet-oc3` - OC-3/STM-1\n* `sonet-oc12` - OC-12/STM-4\n* `sonet-oc48` - OC-48/STM-16\n* `sonet-oc192` - OC-192/STM-64\n* `sonet-oc768` - OC-768/STM-256\n* `sonet-oc1920` - OC-1920/STM-640\n* `sonet-oc3840` - OC-3840/STM-1234\n* `1gfc-sfp` - SFP (1GFC)\n* `2gfc-sfp` - SFP (2GFC)\n* `4gfc-sfp` - SFP (4GFC)\n* `8gfc-sfpp` - SFP+ (8GFC)\n* `16gfc-sfpp` - SFP+ (16GFC)\n* `32gfc-sfp28` - SFP28 (32GFC)\n* `32gfc-sfpp` - SFP+ (32GFC)\n* `64gfc-qsfpp` - QSFP+ (64GFC)\n* `64gfc-sfpdd` - SFP-DD (64GFC)\n* `64gfc-sfpp` - SFP+ (64GFC)\n* `128gfc-qsfp28` - QSFP28 (128GFC)\n* `infiniband-sdr` - SDR (2 Gbps)\n* `infiniband-ddr` - DDR (4 Gbps)\n* `infiniband-qdr` - QDR (8 Gbps)\n* `infiniband-fdr10` - FDR10 (10 Gbps)\n* `infiniband-fdr` - FDR (13.5 Gbps)\n* `infiniband-edr` - EDR (25 Gbps)\n* `infiniband-hdr` - HDR (50 Gbps)\n* `infiniband-ndr` - NDR (100 Gbps)\n* `infiniband-xdr` - XDR (250 Gbps)\n* `t1` - T1 (1.544 Mbps)\n* `e1` - E1 (2.048 Mbps)\n* `t3` - T3 (45 Mbps)\n* `e3` - E3 (34 Mbps)\n* `xdsl` - xDSL\n* `docsis` - DOCSIS\n* `moca` - MoCA\n* `bpon` - BPON (622 Mbps / 155 Mbps)\n* `epon` - EPON (1 Gbps)\n* `10g-epon` - 10G-EPON (10 Gbps)\n* `gpon` - GPON (2.5 Gbps / 1.25 Gbps)\n* `xg-pon` - XG-PON (10 Gbps / 2.5 Gbps)\n* `xgs-pon` - XGS-PON (10 Gbps)\n* `ng-pon2` - NG-PON2 (TWDM-PON) (4x10 Gbps)\n* `25g-pon` - 25G-PON (25 Gbps)\n* `50g-pon` - 50G-PON (50 Gbps)\n* `cisco-stackwise` - Cisco StackWise\n* `cisco-stackwise-plus` - Cisco StackWise Plus\n* `cisco-flexstack` - Cisco FlexStack\n* `cisco-flexstack-plus` - Cisco FlexStack Plus\n* `cisco-stackwise-80` - Cisco StackWise-80\n* `cisco-stackwise-160` - Cisco StackWise-160\n* `cisco-stackwise-320` - Cisco StackWise-320\n* `cisco-stackwise-480` - Cisco StackWise-480\n* `cisco-stackwise-1t` - Cisco StackWise-1T\n* `juniper-vcp` - Juniper VCP\n* `extreme-summitstack` - Extreme SummitStack\n* `extreme-summitstack-128` - Extreme SummitStack-128\n* `extreme-summitstack-256` - Extreme SummitStack-256\n* `extreme-summitstack-512` - Extreme SummitStack-512\n* `other` - Other",
"x-spec-enum-id": "8c4c5e112f77a383"
},
"label": {
"type": "string",
"enum": [
"Virtual",
"Bridge",
"Link Aggregation Group (LAG)",
"100BASE-FX (10/100ME FIBER)",
"100BASE-LFX (10/100ME FIBER)",
"100BASE-TX (10/100ME)",
"100BASE-T1 (10/100ME Single Pair)",
"1000BASE-T (1GE)",
"1000BASE-SX (1GE)",
"1000BASE-LX (1GE)",
"1000BASE-TX (1GE)",
"2.5GBASE-T (2.5GE)",
"5GBASE-T (5GE)",
"10GBASE-T (10GE)",
"10GBASE-CX4 (10GE)",
"SFP (100ME)",
"GBIC (1GE)",
"SFP (1GE)",
"SFP+ (10GE)",
"XFP (10GE)",
"XENPAK (10GE)",
"X2 (10GE)",
"SFP28 (25GE)",
"SFP56 (50GE)",
"QSFP+ (40GE)",
"QSFP28 (50GE)",
"CFP (100GE)",
"CFP2 (100GE)",
"CFP2 (200GE)",
"CFP2 (400GE)",
"CFP4 (100GE)",
"CXP (100GE)",
"Cisco CPAK (100GE)",
"DSFP (100GE)",
"SFP-DD (100GE)",
"QSFP28 (100GE)",
"QSFP-DD (100GE)",
"QSFP56 (200GE)",
"QSFP-DD (200GE)",
"QSFP112 (400GE)",
"QSFP-DD (400GE)",
"OSFP (400GE)",
"OSFP-RHS (400GE)",
"CDFP (400GE)",
"CPF8 (400GE)",
"QSFP-DD (800GE)",
"OSFP (800GE)",
"1000BASE-KX (1GE)",
"2.5GBASE-KX (2.5GE)",
"5GBASE-KR (5GE)",
"10GBASE-KR (10GE)",
"10GBASE-KX4 (10GE)",
"25GBASE-KR (25GE)",
"40GBASE-KR4 (40GE)",
"50GBASE-KR (50GE)",
"100GBASE-KP4 (100GE)",
"100GBASE-KR2 (100GE)",
"100GBASE-KR4 (100GE)",
"IEEE 802.11a",
"IEEE 802.11b/g",
"IEEE 802.11n",
"IEEE 802.11ac",
"IEEE 802.11ad",
"IEEE 802.11ax",
"IEEE 802.11ay",
"IEEE 802.11be",
"IEEE 802.15.1 (Bluetooth)",
"IEEE 802.15.4 (LR-WPAN)",
"Other (Wireless)",
"GSM",
"CDMA",
"LTE",
"4G",
"5G",
"OC-3/STM-1",
"OC-12/STM-4",
"OC-48/STM-16",
"OC-192/STM-64",
"OC-768/STM-256",
"OC-1920/STM-640",
"OC-3840/STM-1234",
"SFP (1GFC)",
"SFP (2GFC)",
"SFP (4GFC)",
"SFP+ (8GFC)",
"SFP+ (16GFC)",
"SFP28 (32GFC)",
"SFP+ (32GFC)",
"QSFP+ (64GFC)",
"SFP-DD (64GFC)",
"SFP+ (64GFC)",
"QSFP28 (128GFC)",
"SDR (2 Gbps)",
"DDR (4 Gbps)",
"QDR (8 Gbps)",
"FDR10 (10 Gbps)",
"FDR (13.5 Gbps)",
"EDR (25 Gbps)",
"HDR (50 Gbps)",
"NDR (100 Gbps)",
"XDR (250 Gbps)",
"T1 (1.544 Mbps)",
"E1 (2.048 Mbps)",
"T3 (45 Mbps)",
"E3 (34 Mbps)",
"xDSL",
"DOCSIS",
"MoCA",
"BPON (622 Mbps / 155 Mbps)",
"EPON (1 Gbps)",
"10G-EPON (10 Gbps)",
"GPON (2.5 Gbps / 1.25 Gbps)",
"XG-PON (10 Gbps / 2.5 Gbps)",
"XGS-PON (10 Gbps)",
"NG-PON2 (TWDM-PON) (4x10 Gbps)",
"25G-PON (25 Gbps)",
"50G-PON (50 Gbps)",
"Cisco StackWise",
"Cisco StackWise Plus",
"Cisco FlexStack",
"Cisco FlexStack Plus",
"Cisco StackWise-80",
"Cisco StackWise-160",
"Cisco StackWise-320",
"Cisco StackWise-480",
"Cisco StackWise-1T",
"Juniper VCP",
"Extreme SummitStack",
"Extreme SummitStack-128",
"Extreme SummitStack-256",
"Extreme SummitStack-512",
"Other"
]
}
}
},
"enabled": {
"type": "boolean"
},
"mgmt_only": {
"type": "boolean",
"title": "Management only"
},
"description": {
"type": "string",
"maxLength": 200
},
"bridge": {
"allOf": [
{
"$ref": "#/components/schemas/NestedInterfaceTemplate"
}
],
"nullable": true
},
"poe_mode": {
"type": "object",
"properties": {
"value": {
"enum": [
"pd",
"pse",
"",
null
],
"type": "string",
"description": "* `pd` - PD\n* `pse` - PSE",
"x-spec-enum-id": "2f2fe6dcdc7772bd"
},
"label": {
"type": "string",
"enum": [
"PD",
"PSE"
]
}
},
"nullable": true
},
"poe_type": {
"type": "object",
"properties": {
"value": {
"enum": [
"type1-ieee802.3af",
"type2-ieee802.3at",
"type3-ieee802.3bt",
"type4-ieee802.3bt",
"passive-24v-2pair",
"passive-24v-4pair",
"passive-48v-2pair",
"passive-48v-4pair",
"",
null
],
"type": "string",
"description": "* `type1-ieee802.3af` - 802.3af (Type 1)\n* `type2-ieee802.3at` - 802.3at (Type 2)\n* `type3-ieee802.3bt` - 802.3bt (Type 3)\n* `type4-ieee802.3bt` - 802.3bt (Type 4)\n* `passive-24v-2pair` - Passive 24V (2-pair)\n* `passive-24v-4pair` - Passive 24V (4-pair)\n* `passive-48v-2pair` - Passive 48V (2-pair)\n* `passive-48v-4pair` - Passive 48V (4-pair)",
"x-spec-enum-id": "74bd3be4012f6da9"
},
"label": {
"type": "string",
"enum": [
"802.3af (Type 1)",
"802.3at (Type 2)",
"802.3bt (Type 3)",
"802.3bt (Type 4)",
"Passive 24V (2-pair)",
"Passive 24V (4-pair)",
"Passive 48V (2-pair)",
"Passive 48V (4-pair)"
]
}
},
"nullable": true
},
"rf_role": {
"type": "object",
"properties": {
"value": {
"enum": [
"ap",
"station",
"",
null
],
"type": "string",
"description": "* `ap` - Access point\n* `station` - Station",
"x-spec-enum-id": "d2772dbea88b0fb1"
},
"label": {
"type": "string",
"enum": [
"Access point",
"Station"
]
}
},
"nullable": true
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"created",
"display",
"id",
"last_updated",
"name",
"type",
"url"
]
},
"InterfaceTemplateRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"device_type": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefDeviceTypeRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"module_type": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleTypeRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"description": "{module} is accepted as a substitution for the module bay position when attached to a module type.",
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"enum": [
"virtual",
"bridge",
"lag",
"100base-fx",
"100base-lfx",
"100base-tx",
"100base-t1",
"1000base-t",
"1000base-sx",
"1000base-lx",
"1000base-tx",
"2.5gbase-t",
"5gbase-t",
"10gbase-t",
"10gbase-cx4",
"100base-x-sfp",
"1000base-x-gbic",
"1000base-x-sfp",
"10gbase-x-sfpp",
"10gbase-x-xfp",
"10gbase-x-xenpak",
"10gbase-x-x2",
"25gbase-x-sfp28",
"50gbase-x-sfp56",
"40gbase-x-qsfpp",
"50gbase-x-sfp28",
"100gbase-x-cfp",
"100gbase-x-cfp2",
"200gbase-x-cfp2",
"400gbase-x-cfp2",
"100gbase-x-cfp4",
"100gbase-x-cxp",
"100gbase-x-cpak",
"100gbase-x-dsfp",
"100gbase-x-sfpdd",
"100gbase-x-qsfp28",
"100gbase-x-qsfpdd",
"200gbase-x-qsfp56",
"200gbase-x-qsfpdd",
"400gbase-x-qsfp112",
"400gbase-x-qsfpdd",
"400gbase-x-osfp",
"400gbase-x-osfp-rhs",
"400gbase-x-cdfp",
"400gbase-x-cfp8",
"800gbase-x-qsfpdd",
"800gbase-x-osfp",
"1000base-kx",
"2.5gbase-kx",
"5gbase-kr",
"10gbase-kr",
"10gbase-kx4",
"25gbase-kr",
"40gbase-kr4",
"50gbase-kr",
"100gbase-kp4",
"100gbase-kr2",
"100gbase-kr4",
"ieee802.11a",
"ieee802.11g",
"ieee802.11n",
"ieee802.11ac",
"ieee802.11ad",
"ieee802.11ax",
"ieee802.11ay",
"ieee802.11be",
"ieee802.15.1",
"ieee802.15.4",
"other-wireless",
"gsm",
"cdma",
"lte",
"4g",
"5g",
"sonet-oc3",
"sonet-oc12",
"sonet-oc48",
"sonet-oc192",
"sonet-oc768",
"sonet-oc1920",
"sonet-oc3840",
"1gfc-sfp",
"2gfc-sfp",
"4gfc-sfp",
"8gfc-sfpp",
"16gfc-sfpp",
"32gfc-sfp28",
"32gfc-sfpp",
"64gfc-qsfpp",
"64gfc-sfpdd",
"64gfc-sfpp",
"128gfc-qsfp28",
"infiniband-sdr",
"infiniband-ddr",
"infiniband-qdr",
"infiniband-fdr10",
"infiniband-fdr",
"infiniband-edr",
"infiniband-hdr",
"infiniband-ndr",
"infiniband-xdr",
"t1",
"e1",
"t3",
"e3",
"xdsl",
"docsis",
"moca",
"bpon",
"epon",
"10g-epon",
"gpon",
"xg-pon",
"xgs-pon",
"ng-pon2",
"25g-pon",
"50g-pon",
"cisco-stackwise",
"cisco-stackwise-plus",
"cisco-flexstack",
"cisco-flexstack-plus",
"cisco-stackwise-80",
"cisco-stackwise-160",
"cisco-stackwise-320",
"cisco-stackwise-480",
"cisco-stackwise-1t",
"juniper-vcp",
"extreme-summitstack",
"extreme-summitstack-128",
"extreme-summitstack-256",
"extreme-summitstack-512",
"other"
],
"type": "string",
"description": "* `virtual` - Virtual\n* `bridge` - Bridge\n* `lag` - Link Aggregation Group (LAG)\n* `100base-fx` - 100BASE-FX (10/100ME FIBER)\n* `100base-lfx` - 100BASE-LFX (10/100ME FIBER)\n* `100base-tx` - 100BASE-TX (10/100ME)\n* `100base-t1` - 100BASE-T1 (10/100ME Single Pair)\n* `1000base-t` - 1000BASE-T (1GE)\n* `1000base-sx` - 1000BASE-SX (1GE)\n* `1000base-lx` - 1000BASE-LX (1GE)\n* `1000base-tx` - 1000BASE-TX (1GE)\n* `2.5gbase-t` - 2.5GBASE-T (2.5GE)\n* `5gbase-t` - 5GBASE-T (5GE)\n* `10gbase-t` - 10GBASE-T (10GE)\n* `10gbase-cx4` - 10GBASE-CX4 (10GE)\n* `100base-x-sfp` - SFP (100ME)\n* `1000base-x-gbic` - GBIC (1GE)\n* `1000base-x-sfp` - SFP (1GE)\n* `10gbase-x-sfpp` - SFP+ (10GE)\n* `10gbase-x-xfp` - XFP (10GE)\n* `10gbase-x-xenpak` - XENPAK (10GE)\n* `10gbase-x-x2` - X2 (10GE)\n* `25gbase-x-sfp28` - SFP28 (25GE)\n* `50gbase-x-sfp56` - SFP56 (50GE)\n* `40gbase-x-qsfpp` - QSFP+ (40GE)\n* `50gbase-x-sfp28` - QSFP28 (50GE)\n* `100gbase-x-cfp` - CFP (100GE)\n* `100gbase-x-cfp2` - CFP2 (100GE)\n* `200gbase-x-cfp2` - CFP2 (200GE)\n* `400gbase-x-cfp2` - CFP2 (400GE)\n* `100gbase-x-cfp4` - CFP4 (100GE)\n* `100gbase-x-cxp` - CXP (100GE)\n* `100gbase-x-cpak` - Cisco CPAK (100GE)\n* `100gbase-x-dsfp` - DSFP (100GE)\n* `100gbase-x-sfpdd` - SFP-DD (100GE)\n* `100gbase-x-qsfp28` - QSFP28 (100GE)\n* `100gbase-x-qsfpdd` - QSFP-DD (100GE)\n* `200gbase-x-qsfp56` - QSFP56 (200GE)\n* `200gbase-x-qsfpdd` - QSFP-DD (200GE)\n* `400gbase-x-qsfp112` - QSFP112 (400GE)\n* `400gbase-x-qsfpdd` - QSFP-DD (400GE)\n* `400gbase-x-osfp` - OSFP (400GE)\n* `400gbase-x-osfp-rhs` - OSFP-RHS (400GE)\n* `400gbase-x-cdfp` - CDFP (400GE)\n* `400gbase-x-cfp8` - CPF8 (400GE)\n* `800gbase-x-qsfpdd` - QSFP-DD (800GE)\n* `800gbase-x-osfp` - OSFP (800GE)\n* `1000base-kx` - 1000BASE-KX (1GE)\n* `2.5gbase-kx` - 2.5GBASE-KX (2.5GE)\n* `5gbase-kr` - 5GBASE-KR (5GE)\n* `10gbase-kr` - 10GBASE-KR (10GE)\n* `10gbase-kx4` - 10GBASE-KX4 (10GE)\n* `25gbase-kr` - 25GBASE-KR (25GE)\n* `40gbase-kr4` - 40GBASE-KR4 (40GE)\n* `50gbase-kr` - 50GBASE-KR (50GE)\n* `100gbase-kp4` - 100GBASE-KP4 (100GE)\n* `100gbase-kr2` - 100GBASE-KR2 (100GE)\n* `100gbase-kr4` - 100GBASE-KR4 (100GE)\n* `ieee802.11a` - IEEE 802.11a\n* `ieee802.11g` - IEEE 802.11b/g\n* `ieee802.11n` - IEEE 802.11n\n* `ieee802.11ac` - IEEE 802.11ac\n* `ieee802.11ad` - IEEE 802.11ad\n* `ieee802.11ax` - IEEE 802.11ax\n* `ieee802.11ay` - IEEE 802.11ay\n* `ieee802.11be` - IEEE 802.11be\n* `ieee802.15.1` - IEEE 802.15.1 (Bluetooth)\n* `ieee802.15.4` - IEEE 802.15.4 (LR-WPAN)\n* `other-wireless` - Other (Wireless)\n* `gsm` - GSM\n* `cdma` - CDMA\n* `lte` - LTE\n* `4g` - 4G\n* `5g` - 5G\n* `sonet-oc3` - OC-3/STM-1\n* `sonet-oc12` - OC-12/STM-4\n* `sonet-oc48` - OC-48/STM-16\n* `sonet-oc192` - OC-192/STM-64\n* `sonet-oc768` - OC-768/STM-256\n* `sonet-oc1920` - OC-1920/STM-640\n* `sonet-oc3840` - OC-3840/STM-1234\n* `1gfc-sfp` - SFP (1GFC)\n* `2gfc-sfp` - SFP (2GFC)\n* `4gfc-sfp` - SFP (4GFC)\n* `8gfc-sfpp` - SFP+ (8GFC)\n* `16gfc-sfpp` - SFP+ (16GFC)\n* `32gfc-sfp28` - SFP28 (32GFC)\n* `32gfc-sfpp` - SFP+ (32GFC)\n* `64gfc-qsfpp` - QSFP+ (64GFC)\n* `64gfc-sfpdd` - SFP-DD (64GFC)\n* `64gfc-sfpp` - SFP+ (64GFC)\n* `128gfc-qsfp28` - QSFP28 (128GFC)\n* `infiniband-sdr` - SDR (2 Gbps)\n* `infiniband-ddr` - DDR (4 Gbps)\n* `infiniband-qdr` - QDR (8 Gbps)\n* `infiniband-fdr10` - FDR10 (10 Gbps)\n* `infiniband-fdr` - FDR (13.5 Gbps)\n* `infiniband-edr` - EDR (25 Gbps)\n* `infiniband-hdr` - HDR (50 Gbps)\n* `infiniband-ndr` - NDR (100 Gbps)\n* `infiniband-xdr` - XDR (250 Gbps)\n* `t1` - T1 (1.544 Mbps)\n* `e1` - E1 (2.048 Mbps)\n* `t3` - T3 (45 Mbps)\n* `e3` - E3 (34 Mbps)\n* `xdsl` - xDSL\n* `docsis` - DOCSIS\n* `moca` - MoCA\n* `bpon` - BPON (622 Mbps / 155 Mbps)\n* `epon` - EPON (1 Gbps)\n* `10g-epon` - 10G-EPON (10 Gbps)\n* `gpon` - GPON (2.5 Gbps / 1.25 Gbps)\n* `xg-pon` - XG-PON (10 Gbps / 2.5 Gbps)\n* `xgs-pon` - XGS-PON (10 Gbps)\n* `ng-pon2` - NG-PON2 (TWDM-PON) (4x10 Gbps)\n* `25g-pon` - 25G-PON (25 Gbps)\n* `50g-pon` - 50G-PON (50 Gbps)\n* `cisco-stackwise` - Cisco StackWise\n* `cisco-stackwise-plus` - Cisco StackWise Plus\n* `cisco-flexstack` - Cisco FlexStack\n* `cisco-flexstack-plus` - Cisco FlexStack Plus\n* `cisco-stackwise-80` - Cisco StackWise-80\n* `cisco-stackwise-160` - Cisco StackWise-160\n* `cisco-stackwise-320` - Cisco StackWise-320\n* `cisco-stackwise-480` - Cisco StackWise-480\n* `cisco-stackwise-1t` - Cisco StackWise-1T\n* `juniper-vcp` - Juniper VCP\n* `extreme-summitstack` - Extreme SummitStack\n* `extreme-summitstack-128` - Extreme SummitStack-128\n* `extreme-summitstack-256` - Extreme SummitStack-256\n* `extreme-summitstack-512` - Extreme SummitStack-512\n* `other` - Other",
"x-spec-enum-id": "8c4c5e112f77a383"
},
"enabled": {
"type": "boolean"
},
"mgmt_only": {
"type": "boolean",
"title": "Management only"
},
"description": {
"type": "string",
"maxLength": 200
},
"bridge": {
"allOf": [
{
"$ref": "#/components/schemas/NestedInterfaceTemplateRequest"
}
],
"nullable": true
},
"poe_mode": {
"enum": [
"pd",
"pse",
"",
null
],
"type": "string",
"description": "* `pd` - PD\n* `pse` - PSE",
"x-spec-enum-id": "2f2fe6dcdc7772bd",
"nullable": true
},
"poe_type": {
"enum": [
"type1-ieee802.3af",
"type2-ieee802.3at",
"type3-ieee802.3bt",
"type4-ieee802.3bt",
"passive-24v-2pair",
"passive-24v-4pair",
"passive-48v-2pair",
"passive-48v-4pair",
"",
null
],
"type": "string",
"description": "* `type1-ieee802.3af` - 802.3af (Type 1)\n* `type2-ieee802.3at` - 802.3at (Type 2)\n* `type3-ieee802.3bt` - 802.3bt (Type 3)\n* `type4-ieee802.3bt` - 802.3bt (Type 4)\n* `passive-24v-2pair` - Passive 24V (2-pair)\n* `passive-24v-4pair` - Passive 24V (4-pair)\n* `passive-48v-2pair` - Passive 48V (2-pair)\n* `passive-48v-4pair` - Passive 48V (4-pair)",
"x-spec-enum-id": "74bd3be4012f6da9",
"nullable": true
},
"rf_role": {
"enum": [
"ap",
"station",
"",
null
],
"type": "string",
"description": "* `ap` - Access point\n* `station` - Station",
"x-spec-enum-id": "d2772dbea88b0fb1",
"nullable": true
}
},
"required": [
"name",
"type"
]
},
"InventoryItem": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"device": {
"$ref": "#/components/schemas/BriefDevice"
},
"parent": {
"type": "integer",
"nullable": true
},
"name": {
"type": "string",
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"status": {
"type": "object",
"properties": {
"value": {
"enum": [
"offline",
"active",
"planned",
"staged",
"failed",
"decommissioning"
],
"type": "string",
"description": "* `offline` - Offline\n* `active` - Active\n* `planned` - Planned\n* `staged` - Staged\n* `failed` - Failed\n* `decommissioning` - Decommissioning",
"x-spec-enum-id": "2217e87d0c3efdda"
},
"label": {
"type": "string",
"enum": [
"Offline",
"Active",
"Planned",
"Staged",
"Failed",
"Decommissioning"
]
}
}
},
"role": {
"allOf": [
{
"$ref": "#/components/schemas/BriefInventoryItemRole"
}
],
"nullable": true
},
"manufacturer": {
"allOf": [
{
"$ref": "#/components/schemas/BriefManufacturer"
}
],
"nullable": true
},
"part_id": {
"type": "string",
"description": "Manufacturer-assigned part identifier",
"maxLength": 50
},
"serial": {
"type": "string",
"title": "Serial number",
"maxLength": 50
},
"asset_tag": {
"type": "string",
"nullable": true,
"description": "A unique tag used to identify this item",
"maxLength": 50
},
"discovered": {
"type": "boolean",
"description": "This item was automatically discovered"
},
"description": {
"type": "string",
"maxLength": 200
},
"component_type": {
"type": "string",
"nullable": true
},
"component_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64",
"nullable": true
},
"component": {
"nullable": true,
"readOnly": true
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"_depth": {
"type": "integer",
"readOnly": true,
"title": " depth"
}
},
"required": [
"_depth",
"component",
"created",
"device",
"display",
"display_url",
"id",
"last_updated",
"name",
"url"
]
},
"InventoryItemRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"device": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDeviceRequest"
}
]
},
"parent": {
"type": "integer",
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"status": {
"enum": [
"offline",
"active",
"planned",
"staged",
"failed",
"decommissioning"
],
"type": "string",
"description": "* `offline` - Offline\n* `active` - Active\n* `planned` - Planned\n* `staged` - Staged\n* `failed` - Failed\n* `decommissioning` - Decommissioning",
"x-spec-enum-id": "2217e87d0c3efdda"
},
"role": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefInventoryItemRoleRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"manufacturer": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefManufacturerRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"part_id": {
"type": "string",
"description": "Manufacturer-assigned part identifier",
"maxLength": 50
},
"serial": {
"type": "string",
"title": "Serial number",
"maxLength": 50
},
"asset_tag": {
"type": "string",
"nullable": true,
"description": "A unique tag used to identify this item",
"maxLength": 50
},
"discovered": {
"type": "boolean",
"description": "This item was automatically discovered"
},
"description": {
"type": "string",
"maxLength": 200
},
"component_type": {
"type": "string",
"nullable": true
},
"component_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64",
"nullable": true
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"device",
"name"
]
},
"InventoryItemRole": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"color": {
"type": "string",
"pattern": "^[0-9a-f]{6}$",
"maxLength": 6
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"inventoryitem_count": {
"type": "integer",
"format": "int64",
"readOnly": true
}
},
"required": [
"created",
"display",
"display_url",
"id",
"inventoryitem_count",
"last_updated",
"name",
"slug",
"url"
]
},
"InventoryItemRoleRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"color": {
"type": "string",
"minLength": 1,
"pattern": "^[0-9a-f]{6}$",
"maxLength": 6
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name",
"slug"
]
},
"InventoryItemTemplate": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"device_type": {
"$ref": "#/components/schemas/BriefDeviceType"
},
"parent": {
"type": "integer",
"nullable": true
},
"name": {
"type": "string",
"description": "{module} is accepted as a substitution for the module bay position when attached to a module type.",
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"role": {
"allOf": [
{
"$ref": "#/components/schemas/BriefInventoryItemRole"
}
],
"nullable": true
},
"manufacturer": {
"allOf": [
{
"$ref": "#/components/schemas/BriefManufacturer"
}
],
"nullable": true
},
"part_id": {
"type": "string",
"description": "Manufacturer-assigned part identifier",
"maxLength": 50
},
"description": {
"type": "string",
"maxLength": 200
},
"component_type": {
"type": "string",
"nullable": true
},
"component_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64",
"nullable": true
},
"component": {
"nullable": true,
"readOnly": true
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"_depth": {
"type": "integer",
"readOnly": true,
"title": " depth"
}
},
"required": [
"_depth",
"component",
"created",
"device_type",
"display",
"id",
"last_updated",
"name",
"url"
]
},
"InventoryItemTemplateRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"device_type": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDeviceTypeRequest"
}
]
},
"parent": {
"type": "integer",
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"description": "{module} is accepted as a substitution for the module bay position when attached to a module type.",
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"role": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefInventoryItemRoleRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"manufacturer": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefManufacturerRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"part_id": {
"type": "string",
"description": "Manufacturer-assigned part identifier",
"maxLength": 50
},
"description": {
"type": "string",
"maxLength": 200
},
"component_type": {
"type": "string",
"nullable": true
},
"component_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64",
"nullable": true
}
},
"required": [
"device_type",
"name"
]
},
"Job": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"object_type": {
"type": "string",
"readOnly": true
},
"object_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64",
"nullable": true
},
"name": {
"type": "string",
"maxLength": 200
},
"status": {
"type": "object",
"properties": {
"value": {
"enum": [
"pending",
"scheduled",
"running",
"completed",
"errored",
"failed"
],
"type": "string",
"description": "* `pending` - Pending\n* `scheduled` - Scheduled\n* `running` - Running\n* `completed` - Completed\n* `errored` - Errored\n* `failed` - Failed",
"x-spec-enum-id": "e33887d83efcc138"
},
"label": {
"type": "string",
"enum": [
"Pending",
"Scheduled",
"Running",
"Completed",
"Errored",
"Failed"
]
}
},
"readOnly": true
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"scheduled": {
"type": "string",
"format": "date-time",
"nullable": true
},
"interval": {
"type": "integer",
"maximum": 2147483647,
"minimum": 1,
"nullable": true,
"description": "Recurrence interval (in minutes)"
},
"started": {
"type": "string",
"format": "date-time",
"nullable": true
},
"completed": {
"type": "string",
"format": "date-time",
"nullable": true
},
"user": {
"allOf": [
{
"$ref": "#/components/schemas/BriefUser"
}
],
"readOnly": true
},
"data": {
"nullable": true
},
"error": {
"type": "string",
"readOnly": true
},
"job_id": {
"type": "string",
"format": "uuid"
},
"log_entries": {
"type": "array",
"items": {}
}
},
"required": [
"created",
"display",
"display_url",
"error",
"id",
"job_id",
"name",
"object_type",
"status",
"url",
"user"
]
},
"JournalEntry": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"assigned_object_type": {
"type": "string"
},
"assigned_object_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64"
},
"assigned_object": {
"nullable": true,
"readOnly": true
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"created_by": {
"type": "integer",
"nullable": true
},
"kind": {
"type": "object",
"properties": {
"value": {
"enum": [
"info",
"success",
"warning",
"danger"
],
"type": "string",
"description": "* `info` - Info\n* `success` - Success\n* `warning` - Warning\n* `danger` - Danger",
"x-spec-enum-id": "a21af280f632fa34"
},
"label": {
"type": "string",
"enum": [
"Info",
"Success",
"Warning",
"Danger"
]
}
}
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"assigned_object",
"assigned_object_id",
"assigned_object_type",
"comments",
"created",
"display",
"display_url",
"id",
"last_updated",
"url"
]
},
"JournalEntryRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"assigned_object_type": {
"type": "string"
},
"assigned_object_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64"
},
"created_by": {
"type": "integer",
"nullable": true
},
"kind": {
"enum": [
"info",
"success",
"warning",
"danger"
],
"type": "string",
"description": "* `info` - Info\n* `success` - Success\n* `warning` - Warning\n* `danger` - Danger",
"x-spec-enum-id": "a21af280f632fa34"
},
"comments": {
"type": "string",
"minLength": 1
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"assigned_object_id",
"assigned_object_type",
"comments"
]
},
"L2VPN": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"identifier": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"format": "int64",
"nullable": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"type": {
"type": "object",
"properties": {
"value": {
"enum": [
"vpws",
"vpls",
"vxlan",
"vxlan-evpn",
"mpls-evpn",
"pbb-evpn",
"evpn-vpws",
"epl",
"evpl",
"ep-lan",
"evp-lan",
"ep-tree",
"evp-tree",
"spb"
],
"type": "string",
"description": "* `vpws` - VPWS\n* `vpls` - VPLS\n* `vxlan` - VXLAN\n* `vxlan-evpn` - VXLAN-EVPN\n* `mpls-evpn` - MPLS EVPN\n* `pbb-evpn` - PBB EVPN\n* `evpn-vpws` - EVPN VPWS\n* `epl` - EPL\n* `evpl` - EVPL\n* `ep-lan` - Ethernet Private LAN\n* `evp-lan` - Ethernet Virtual Private LAN\n* `ep-tree` - Ethernet Private Tree\n* `evp-tree` - Ethernet Virtual Private Tree\n* `spb` - SPB",
"x-spec-enum-id": "730136816a2885f9"
},
"label": {
"type": "string",
"enum": [
"VPWS",
"VPLS",
"VXLAN",
"VXLAN-EVPN",
"MPLS EVPN",
"PBB EVPN",
"EVPN VPWS",
"EPL",
"EVPL",
"Ethernet Private LAN",
"Ethernet Virtual Private LAN",
"Ethernet Private Tree",
"Ethernet Virtual Private Tree",
"SPB"
]
}
}
},
"status": {
"type": "object",
"properties": {
"value": {
"enum": [
"active",
"planned",
"decommissioning"
],
"type": "string",
"description": "* `active` - Active\n* `planned` - Planned\n* `decommissioning` - Decommissioning",
"x-spec-enum-id": "937bacafb9d5d4bb"
},
"label": {
"type": "string",
"enum": [
"Active",
"Planned",
"Decommissioning"
]
}
}
},
"import_targets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RouteTarget"
}
},
"export_targets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RouteTarget"
}
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tenant": {
"allOf": [
{
"$ref": "#/components/schemas/BriefTenant"
}
],
"nullable": true
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"created",
"display",
"display_url",
"id",
"last_updated",
"name",
"slug",
"url"
]
},
"L2VPNRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"identifier": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"format": "int64",
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"type": {
"enum": [
"vpws",
"vpls",
"vxlan",
"vxlan-evpn",
"mpls-evpn",
"pbb-evpn",
"evpn-vpws",
"epl",
"evpl",
"ep-lan",
"evp-lan",
"ep-tree",
"evp-tree",
"spb"
],
"type": "string",
"description": "* `vpws` - VPWS\n* `vpls` - VPLS\n* `vxlan` - VXLAN\n* `vxlan-evpn` - VXLAN-EVPN\n* `mpls-evpn` - MPLS EVPN\n* `pbb-evpn` - PBB EVPN\n* `evpn-vpws` - EVPN VPWS\n* `epl` - EPL\n* `evpl` - EVPL\n* `ep-lan` - Ethernet Private LAN\n* `evp-lan` - Ethernet Virtual Private LAN\n* `ep-tree` - Ethernet Private Tree\n* `evp-tree` - Ethernet Virtual Private Tree\n* `spb` - SPB",
"x-spec-enum-id": "730136816a2885f9"
},
"status": {
"enum": [
"active",
"planned",
"decommissioning"
],
"type": "string",
"description": "* `active` - Active\n* `planned` - Planned\n* `decommissioning` - Decommissioning",
"x-spec-enum-id": "937bacafb9d5d4bb"
},
"import_targets": {
"type": "array",
"items": {
"type": "integer"
}
},
"export_targets": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name",
"slug"
]
},
"L2VPNTermination": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"l2vpn": {
"$ref": "#/components/schemas/BriefL2VPN"
},
"assigned_object_type": {
"type": "string"
},
"assigned_object_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64"
},
"assigned_object": {
"nullable": true,
"readOnly": true
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"assigned_object",
"assigned_object_id",
"assigned_object_type",
"created",
"display",
"display_url",
"id",
"l2vpn",
"last_updated",
"url"
]
},
"L2VPNTerminationRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"l2vpn": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefL2VPNRequest"
}
]
},
"assigned_object_type": {
"type": "string"
},
"assigned_object_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"assigned_object_id",
"assigned_object_type",
"l2vpn"
]
},
"Location": {
"type": "object",
"description": "Extends PrimaryModelSerializer to include MPTT support.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"site": {
"$ref": "#/components/schemas/BriefSite"
},
"parent": {
"allOf": [
{
"$ref": "#/components/schemas/NestedLocation"
}
],
"nullable": true
},
"status": {
"type": "object",
"properties": {
"value": {
"enum": [
"planned",
"staging",
"active",
"decommissioning",
"retired"
],
"type": "string",
"description": "* `planned` - Planned\n* `staging` - Staging\n* `active` - Active\n* `decommissioning` - Decommissioning\n* `retired` - Retired",
"x-spec-enum-id": "e363a8ddb138be50"
},
"label": {
"type": "string",
"enum": [
"Planned",
"Staging",
"Active",
"Decommissioning",
"Retired"
]
}
}
},
"tenant": {
"allOf": [
{
"$ref": "#/components/schemas/BriefTenant"
}
],
"nullable": true
},
"facility": {
"type": "string",
"description": "Local facility ID or description",
"maxLength": 50
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"rack_count": {
"type": "integer",
"readOnly": true,
"default": 0
},
"device_count": {
"type": "integer",
"readOnly": true,
"default": 0
},
"prefix_count": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"comments": {
"type": "string"
},
"_depth": {
"type": "integer",
"readOnly": true,
"title": " depth"
}
},
"required": [
"_depth",
"created",
"device_count",
"display",
"display_url",
"id",
"last_updated",
"name",
"prefix_count",
"rack_count",
"site",
"slug",
"url"
]
},
"LocationRequest": {
"type": "object",
"description": "Extends PrimaryModelSerializer to include MPTT support.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"site": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefSiteRequest"
}
]
},
"parent": {
"allOf": [
{
"$ref": "#/components/schemas/NestedLocationRequest"
}
],
"nullable": true
},
"status": {
"enum": [
"planned",
"staging",
"active",
"decommissioning",
"retired"
],
"type": "string",
"description": "* `planned` - Planned\n* `staging` - Staging\n* `active` - Active\n* `decommissioning` - Decommissioning\n* `retired` - Retired",
"x-spec-enum-id": "e363a8ddb138be50"
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"facility": {
"type": "string",
"description": "Local facility ID or description",
"maxLength": 50
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"comments": {
"type": "string"
}
},
"required": [
"name",
"site",
"slug"
]
},
"MACAddress": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"mac_address": {
"type": "string"
},
"assigned_object_type": {
"type": "string",
"nullable": true
},
"assigned_object_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64",
"nullable": true
},
"assigned_object": {
"nullable": true,
"readOnly": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"assigned_object",
"created",
"display",
"display_url",
"id",
"last_updated",
"mac_address",
"url"
]
},
"MACAddressRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"mac_address": {
"type": "string"
},
"assigned_object_type": {
"type": "string",
"nullable": true
},
"assigned_object_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"mac_address"
]
},
"Manufacturer": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"devicetype_count": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"inventoryitem_count": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"platform_count": {
"type": "integer",
"format": "int64",
"readOnly": true
}
},
"required": [
"created",
"devicetype_count",
"display",
"display_url",
"id",
"inventoryitem_count",
"last_updated",
"name",
"platform_count",
"slug",
"url"
]
},
"ManufacturerRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name",
"slug"
]
},
"Module": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"device": {
"$ref": "#/components/schemas/BriefDevice"
},
"module_bay": {
"$ref": "#/components/schemas/NestedModuleBay"
},
"module_type": {
"$ref": "#/components/schemas/BriefModuleType"
},
"status": {
"type": "object",
"properties": {
"value": {
"enum": [
"offline",
"active",
"planned",
"staged",
"failed",
"decommissioning"
],
"type": "string",
"description": "* `offline` - Offline\n* `active` - Active\n* `planned` - Planned\n* `staged` - Staged\n* `failed` - Failed\n* `decommissioning` - Decommissioning",
"x-spec-enum-id": "2217e87d0c3efdda"
},
"label": {
"type": "string",
"enum": [
"Offline",
"Active",
"Planned",
"Staged",
"Failed",
"Decommissioning"
]
}
}
},
"serial": {
"type": "string",
"title": "Serial number",
"maxLength": 50
},
"asset_tag": {
"type": "string",
"nullable": true,
"description": "A unique tag used to identify this device",
"maxLength": 50
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"created",
"device",
"display",
"display_url",
"id",
"last_updated",
"module_bay",
"module_type",
"url"
]
},
"ModuleBay": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"device": {
"$ref": "#/components/schemas/BriefDevice"
},
"module": {
"allOf": [
{
"$ref": "#/components/schemas/BriefModule"
}
],
"nullable": true
},
"name": {
"type": "string",
"maxLength": 64
},
"installed_module": {
"allOf": [
{
"$ref": "#/components/schemas/BriefModule"
}
],
"nullable": true
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"position": {
"type": "string",
"description": "Identifier to reference when renaming installed components",
"maxLength": 30
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"created",
"device",
"display",
"display_url",
"id",
"last_updated",
"name",
"url"
]
},
"ModuleBayRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"device": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDeviceRequest"
}
]
},
"module": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"installed_module": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"position": {
"type": "string",
"description": "Identifier to reference when renaming installed components",
"maxLength": 30
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"device",
"name"
]
},
"ModuleBayTemplate": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"device_type": {
"allOf": [
{
"$ref": "#/components/schemas/BriefDeviceType"
}
],
"nullable": true
},
"module_type": {
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleType"
}
],
"nullable": true
},
"name": {
"type": "string",
"description": "{module} is accepted as a substitution for the module bay position when attached to a module type.",
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"position": {
"type": "string",
"description": "Identifier to reference when renaming installed components",
"maxLength": 30
},
"description": {
"type": "string",
"maxLength": 200
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"created",
"display",
"id",
"last_updated",
"name",
"url"
]
},
"ModuleBayTemplateRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"device_type": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefDeviceTypeRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"module_type": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleTypeRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"description": "{module} is accepted as a substitution for the module bay position when attached to a module type.",
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"position": {
"type": "string",
"description": "Identifier to reference when renaming installed components",
"maxLength": 30
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name"
]
},
"ModuleRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"device": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDeviceRequest"
}
]
},
"module_bay": {
"$ref": "#/components/schemas/NestedModuleBayRequest"
},
"module_type": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefModuleTypeRequest"
}
]
},
"status": {
"enum": [
"offline",
"active",
"planned",
"staged",
"failed",
"decommissioning"
],
"type": "string",
"description": "* `offline` - Offline\n* `active` - Active\n* `planned` - Planned\n* `staged` - Staged\n* `failed` - Failed\n* `decommissioning` - Decommissioning",
"x-spec-enum-id": "2217e87d0c3efdda"
},
"serial": {
"type": "string",
"title": "Serial number",
"maxLength": 50
},
"asset_tag": {
"type": "string",
"nullable": true,
"description": "A unique tag used to identify this device",
"maxLength": 50
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"device",
"module_bay",
"module_type"
]
},
"ModuleType": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"profile": {
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleTypeProfile"
}
],
"nullable": true
},
"manufacturer": {
"$ref": "#/components/schemas/BriefManufacturer"
},
"model": {
"type": "string",
"maxLength": 100
},
"part_number": {
"type": "string",
"description": "Discrete part number (optional)",
"maxLength": 50
},
"airflow": {
"type": "object",
"properties": {
"value": {
"enum": [
"front-to-rear",
"rear-to-front",
"left-to-right",
"right-to-left",
"side-to-rear",
"passive",
"",
null
],
"type": "string",
"description": "* `front-to-rear` - Front to rear\n* `rear-to-front` - Rear to front\n* `left-to-right` - Left to right\n* `right-to-left` - Right to left\n* `side-to-rear` - Side to rear\n* `passive` - Passive",
"x-spec-enum-id": "f6e5562e0e98d69d"
},
"label": {
"type": "string",
"enum": [
"Front to rear",
"Rear to front",
"Left to right",
"Right to left",
"Side to rear",
"Passive"
]
}
},
"nullable": true
},
"weight": {
"type": "number",
"format": "double",
"maximum": 1000000,
"minimum": -1000000,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true
},
"weight_unit": {
"type": "object",
"properties": {
"value": {
"enum": [
"kg",
"g",
"lb",
"oz",
"",
null
],
"type": "string",
"description": "* `kg` - Kilograms\n* `g` - Grams\n* `lb` - Pounds\n* `oz` - Ounces",
"x-spec-enum-id": "7c1876f422815884"
},
"label": {
"type": "string",
"enum": [
"Kilograms",
"Grams",
"Pounds",
"Ounces"
]
}
},
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"attributes": {
"nullable": true
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"created",
"display",
"display_url",
"id",
"last_updated",
"manufacturer",
"model",
"url"
]
},
"ModuleTypeProfile": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"schema": {
"nullable": true
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"created",
"display",
"display_url",
"id",
"last_updated",
"name",
"url"
]
},
"ModuleTypeProfileRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"schema": {
"nullable": true
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name"
]
},
"ModuleTypeRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"profile": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleTypeProfileRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"manufacturer": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefManufacturerRequest"
}
]
},
"model": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"part_number": {
"type": "string",
"description": "Discrete part number (optional)",
"maxLength": 50
},
"airflow": {
"enum": [
"front-to-rear",
"rear-to-front",
"left-to-right",
"right-to-left",
"side-to-rear",
"passive",
"",
null
],
"type": "string",
"description": "* `front-to-rear` - Front to rear\n* `rear-to-front` - Rear to front\n* `left-to-right` - Left to right\n* `right-to-left` - Right to left\n* `side-to-rear` - Side to rear\n* `passive` - Passive",
"x-spec-enum-id": "f6e5562e0e98d69d",
"nullable": true
},
"weight": {
"type": "number",
"format": "double",
"maximum": 1000000,
"minimum": -1000000,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true
},
"weight_unit": {
"enum": [
"kg",
"g",
"lb",
"oz",
"",
null
],
"type": "string",
"description": "* `kg` - Kilograms\n* `g` - Grams\n* `lb` - Pounds\n* `oz` - Ounces",
"x-spec-enum-id": "7c1876f422815884",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"attributes": {
"nullable": true
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"manufacturer",
"model"
]
},
"NestedContactGroup": {
"type": "object",
"description": "Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a\ndictionary of attributes which can be used to uniquely identify the related object. This class should be\nsubclassed to return a full representation of the related object on read.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"_depth": {
"type": "integer",
"readOnly": true,
"title": " depth"
}
},
"required": [
"_depth",
"display",
"display_url",
"id",
"name",
"slug",
"url"
]
},
"NestedContactGroupRequest": {
"type": "object",
"description": "Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a\ndictionary of attributes which can be used to uniquely identify the related object. This class should be\nsubclassed to return a full representation of the related object on read.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
}
},
"required": [
"name",
"slug"
]
},
"NestedDevice": {
"type": "object",
"description": "Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a\ndictionary of attributes which can be used to uniquely identify the related object. This class should be\nsubclassed to return a full representation of the related object on read.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"nullable": true,
"maxLength": 64
}
},
"required": [
"display",
"display_url",
"id",
"url"
]
},
"NestedDeviceRequest": {
"type": "object",
"description": "Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a\ndictionary of attributes which can be used to uniquely identify the related object. This class should be\nsubclassed to return a full representation of the related object on read.",
"properties": {
"name": {
"type": "string",
"nullable": true,
"maxLength": 64
}
}
},
"NestedDeviceRole": {
"type": "object",
"description": "Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a\ndictionary of attributes which can be used to uniquely identify the related object. This class should be\nsubclassed to return a full representation of the related object on read.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
}
},
"required": [
"display",
"display_url",
"id",
"name",
"url"
]
},
"NestedDeviceRoleRequest": {
"type": "object",
"description": "Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a\ndictionary of attributes which can be used to uniquely identify the related object. This class should be\nsubclassed to return a full representation of the related object on read.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
}
},
"required": [
"name"
]
},
"NestedGroup": {
"type": "object",
"description": "Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a\ndictionary of attributes which can be used to uniquely identify the related object. This class should be\nsubclassed to return a full representation of the related object on read.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 150
}
},
"required": [
"display",
"display_url",
"id",
"name",
"url"
]
},
"NestedIPAddress": {
"type": "object",
"description": "Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a\ndictionary of attributes which can be used to uniquely identify the related object. This class should be\nsubclassed to return a full representation of the related object on read.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"family": {
"type": "integer",
"readOnly": true
},
"address": {
"type": "string"
}
},
"required": [
"address",
"display",
"display_url",
"family",
"id",
"url"
]
},
"NestedIPAddressRequest": {
"type": "object",
"description": "Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a\ndictionary of attributes which can be used to uniquely identify the related object. This class should be\nsubclassed to return a full representation of the related object on read.",
"properties": {
"address": {
"type": "string",
"minLength": 1
}
},
"required": [
"address"
]
},
"NestedInterface": {
"type": "object",
"description": "Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a\ndictionary of attributes which can be used to uniquely identify the related object. This class should be\nsubclassed to return a full representation of the related object on read.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"device": {
"allOf": [
{
"$ref": "#/components/schemas/NestedDevice"
}
],
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 64
},
"cable": {
"type": "integer",
"nullable": true
},
"_occupied": {
"type": "boolean",
"readOnly": true,
"title": " occupied"
}
},
"required": [
"_occupied",
"device",
"display",
"display_url",
"id",
"name",
"url"
]
},
"NestedInterfaceRequest": {
"type": "object",
"description": "Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a\ndictionary of attributes which can be used to uniquely identify the related object. This class should be\nsubclassed to return a full representation of the related object on read.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"cable": {
"type": "integer",
"nullable": true
}
},
"required": [
"name"
]
},
"NestedInterfaceTemplate": {
"type": "object",
"description": "Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a\ndictionary of attributes which can be used to uniquely identify the related object. This class should be\nsubclassed to return a full representation of the related object on read.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"description": "{module} is accepted as a substitution for the module bay position when attached to a module type.",
"maxLength": 64
}
},
"required": [
"display",
"id",
"name",
"url"
]
},
"NestedInterfaceTemplateRequest": {
"type": "object",
"description": "Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a\ndictionary of attributes which can be used to uniquely identify the related object. This class should be\nsubclassed to return a full representation of the related object on read.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"description": "{module} is accepted as a substitution for the module bay position when attached to a module type.",
"maxLength": 64
}
},
"required": [
"name"
]
},
"NestedLocation": {
"type": "object",
"description": "Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a\ndictionary of attributes which can be used to uniquely identify the related object. This class should be\nsubclassed to return a full representation of the related object on read.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"_depth": {
"type": "integer",
"readOnly": true,
"title": " depth"
}
},
"required": [
"_depth",
"display",
"display_url",
"id",
"name",
"slug",
"url"
]
},
"NestedLocationRequest": {
"type": "object",
"description": "Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a\ndictionary of attributes which can be used to uniquely identify the related object. This class should be\nsubclassed to return a full representation of the related object on read.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
}
},
"required": [
"name",
"slug"
]
},
"NestedModuleBay": {
"type": "object",
"description": "Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a\ndictionary of attributes which can be used to uniquely identify the related object. This class should be\nsubclassed to return a full representation of the related object on read.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 64
}
},
"required": [
"display",
"display_url",
"id",
"name",
"url"
]
},
"NestedModuleBayRequest": {
"type": "object",
"description": "Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a\ndictionary of attributes which can be used to uniquely identify the related object. This class should be\nsubclassed to return a full representation of the related object on read.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
}
},
"required": [
"name"
]
},
"NestedPlatform": {
"type": "object",
"description": "Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a\ndictionary of attributes which can be used to uniquely identify the related object. This class should be\nsubclassed to return a full representation of the related object on read.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
}
},
"required": [
"display",
"display_url",
"id",
"name",
"url"
]
},
"NestedPlatformRequest": {
"type": "object",
"description": "Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a\ndictionary of attributes which can be used to uniquely identify the related object. This class should be\nsubclassed to return a full representation of the related object on read.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
}
},
"required": [
"name"
]
},
"NestedProviderAccount": {
"type": "object",
"description": "Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a\ndictionary of attributes which can be used to uniquely identify the related object. This class should be\nsubclassed to return a full representation of the related object on read.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"account": {
"type": "string",
"title": "Account ID",
"maxLength": 100
}
},
"required": [
"account",
"display",
"display_url",
"id",
"url"
]
},
"NestedRegion": {
"type": "object",
"description": "Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a\ndictionary of attributes which can be used to uniquely identify the related object. This class should be\nsubclassed to return a full representation of the related object on read.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"_depth": {
"type": "integer",
"readOnly": true,
"title": " depth"
}
},
"required": [
"_depth",
"display",
"display_url",
"id",
"name",
"slug",
"url"
]
},
"NestedRegionRequest": {
"type": "object",
"description": "Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a\ndictionary of attributes which can be used to uniquely identify the related object. This class should be\nsubclassed to return a full representation of the related object on read.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
}
},
"required": [
"name",
"slug"
]
},
"NestedSiteGroup": {
"type": "object",
"description": "Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a\ndictionary of attributes which can be used to uniquely identify the related object. This class should be\nsubclassed to return a full representation of the related object on read.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"_depth": {
"type": "integer",
"readOnly": true,
"title": " depth"
}
},
"required": [
"_depth",
"display",
"display_url",
"id",
"name",
"slug",
"url"
]
},
"NestedSiteGroupRequest": {
"type": "object",
"description": "Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a\ndictionary of attributes which can be used to uniquely identify the related object. This class should be\nsubclassed to return a full representation of the related object on read.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
}
},
"required": [
"name",
"slug"
]
},
"NestedTag": {
"type": "object",
"description": "Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a\ndictionary of attributes which can be used to uniquely identify the related object. This class should be\nsubclassed to return a full representation of the related object on read.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"pattern": "^[-\\w]+$",
"maxLength": 100
},
"color": {
"type": "string",
"pattern": "^[0-9a-f]{6}$",
"maxLength": 6
}
},
"required": [
"display",
"display_url",
"id",
"name",
"slug",
"url"
]
},
"NestedTagRequest": {
"type": "object",
"description": "Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a\ndictionary of attributes which can be used to uniquely identify the related object. This class should be\nsubclassed to return a full representation of the related object on read.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"pattern": "^[-\\w]+$",
"maxLength": 100
},
"color": {
"type": "string",
"minLength": 1,
"pattern": "^[0-9a-f]{6}$",
"maxLength": 6
}
},
"required": [
"name",
"slug"
]
},
"NestedTenantGroup": {
"type": "object",
"description": "Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a\ndictionary of attributes which can be used to uniquely identify the related object. This class should be\nsubclassed to return a full representation of the related object on read.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"_depth": {
"type": "integer",
"readOnly": true,
"title": " depth"
}
},
"required": [
"_depth",
"display",
"display_url",
"id",
"name",
"slug",
"url"
]
},
"NestedTenantGroupRequest": {
"type": "object",
"description": "Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a\ndictionary of attributes which can be used to uniquely identify the related object. This class should be\nsubclassed to return a full representation of the related object on read.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
}
},
"required": [
"name",
"slug"
]
},
"NestedUser": {
"type": "object",
"description": "Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a\ndictionary of attributes which can be used to uniquely identify the related object. This class should be\nsubclassed to return a full representation of the related object on read.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"username": {
"type": "string",
"description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
"pattern": "^[\\w.@+-]+$",
"maxLength": 150
}
},
"required": [
"display",
"display_url",
"id",
"url",
"username"
]
},
"NestedVLAN": {
"type": "object",
"description": "Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a\ndictionary of attributes which can be used to uniquely identify the related object. This class should be\nsubclassed to return a full representation of the related object on read.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"vid": {
"type": "integer",
"maximum": 4094,
"minimum": 1,
"title": "VLAN ID",
"description": "Numeric VLAN ID (1-4094)"
},
"name": {
"type": "string",
"maxLength": 64
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"display",
"id",
"name",
"url",
"vid"
]
},
"NestedVLANRequest": {
"type": "object",
"description": "Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a\ndictionary of attributes which can be used to uniquely identify the related object. This class should be\nsubclassed to return a full representation of the related object on read.",
"properties": {
"vid": {
"type": "integer",
"maximum": 4094,
"minimum": 1,
"title": "VLAN ID",
"description": "Numeric VLAN ID (1-4094)"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name",
"vid"
]
},
"NestedVMInterface": {
"type": "object",
"description": "Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a\ndictionary of attributes which can be used to uniquely identify the related object. This class should be\nsubclassed to return a full representation of the related object on read.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"virtual_machine": {
"allOf": [
{
"$ref": "#/components/schemas/NestedVirtualMachine"
}
],
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 64
}
},
"required": [
"display",
"display_url",
"id",
"name",
"url",
"virtual_machine"
]
},
"NestedVMInterfaceRequest": {
"type": "object",
"description": "Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a\ndictionary of attributes which can be used to uniquely identify the related object. This class should be\nsubclassed to return a full representation of the related object on read.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
}
},
"required": [
"name"
]
},
"NestedVirtualMachine": {
"type": "object",
"description": "Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a\ndictionary of attributes which can be used to uniquely identify the related object. This class should be\nsubclassed to return a full representation of the related object on read.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 64
}
},
"required": [
"display",
"display_url",
"id",
"name",
"url"
]
},
"NestedVirtualMachineRequest": {
"type": "object",
"description": "Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a\ndictionary of attributes which can be used to uniquely identify the related object. This class should be\nsubclassed to return a full representation of the related object on read.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
}
},
"required": [
"name"
]
},
"NestedWirelessLANGroup": {
"type": "object",
"description": "Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a\ndictionary of attributes which can be used to uniquely identify the related object. This class should be\nsubclassed to return a full representation of the related object on read.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"_depth": {
"type": "integer",
"readOnly": true,
"title": " depth"
}
},
"required": [
"_depth",
"display",
"display_url",
"id",
"name",
"slug",
"url"
]
},
"NestedWirelessLANGroupRequest": {
"type": "object",
"description": "Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a\ndictionary of attributes which can be used to uniquely identify the related object. This class should be\nsubclassed to return a full representation of the related object on read.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
}
},
"required": [
"name",
"slug"
]
},
"NestedWirelessLink": {
"type": "object",
"description": "Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a\ndictionary of attributes which can be used to uniquely identify the related object. This class should be\nsubclassed to return a full representation of the related object on read.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"ssid": {
"type": "string",
"maxLength": 32
}
},
"required": [
"display",
"display_url",
"id",
"url"
]
},
"NestedWirelessLinkRequest": {
"type": "object",
"description": "Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a\ndictionary of attributes which can be used to uniquely identify the related object. This class should be\nsubclassed to return a full representation of the related object on read.",
"properties": {
"ssid": {
"type": "string",
"maxLength": 32
}
}
},
"Notification": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"object_type": {
"type": "string"
},
"object_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64"
},
"object": {
"nullable": true,
"readOnly": true
},
"user": {
"$ref": "#/components/schemas/BriefUser"
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"read": {
"type": "string",
"format": "date-time",
"nullable": true
},
"event_type": {
"enum": [
"object_created",
"object_updated",
"object_deleted",
"job_started",
"job_completed",
"job_failed",
"job_errored"
],
"type": "string",
"description": "* `object_created` - Object created\n* `object_updated` - Object updated\n* `object_deleted` - Object deleted\n* `job_started` - Job started\n* `job_completed` - Job completed\n* `job_failed` - Job failed\n* `job_errored` - Job errored",
"x-spec-enum-id": "80d172232f4af424",
"title": "Event"
}
},
"required": [
"created",
"display",
"event_type",
"id",
"object",
"object_id",
"object_type",
"url",
"user"
]
},
"NotificationGroup": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Group"
}
},
"users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/User"
}
}
},
"required": [
"display",
"display_url",
"id",
"name",
"url"
]
},
"NotificationGroupRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"groups": {
"type": "array",
"items": {
"type": "integer"
}
},
"users": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"required": [
"name"
]
},
"NotificationRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"object_type": {
"type": "string"
},
"object_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64"
},
"user": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefUserRequest"
}
]
},
"read": {
"type": "string",
"format": "date-time",
"nullable": true
},
"event_type": {
"enum": [
"object_created",
"object_updated",
"object_deleted",
"job_started",
"job_completed",
"job_failed",
"job_errored"
],
"type": "string",
"description": "* `object_created` - Object created\n* `object_updated` - Object updated\n* `object_deleted` - Object deleted\n* `job_started` - Job started\n* `job_completed` - Job completed\n* `job_failed` - Job failed\n* `job_errored` - Job errored",
"x-spec-enum-id": "80d172232f4af424",
"title": "Event"
}
},
"required": [
"event_type",
"object_id",
"object_type",
"user"
]
},
"ObjectChange": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"time": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"user": {
"allOf": [
{
"$ref": "#/components/schemas/BriefUser"
}
],
"readOnly": true
},
"user_name": {
"type": "string",
"readOnly": true
},
"request_id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"action": {
"type": "object",
"properties": {
"value": {
"enum": [
"create",
"update",
"delete"
],
"type": "string",
"description": "* `create` - Created\n* `update` - Updated\n* `delete` - Deleted",
"x-spec-enum-id": "544f9b3b28b7ce6a"
},
"label": {
"type": "string",
"enum": [
"Created",
"Updated",
"Deleted"
]
}
},
"readOnly": true
},
"changed_object_type": {
"type": "string",
"readOnly": true
},
"changed_object_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64"
},
"changed_object": {
"nullable": true,
"readOnly": true
},
"message": {
"type": "string",
"readOnly": true
},
"prechange_data": {
"readOnly": true,
"nullable": true
},
"postchange_data": {
"readOnly": true,
"nullable": true
}
},
"required": [
"action",
"changed_object",
"changed_object_id",
"changed_object_type",
"display",
"display_url",
"id",
"message",
"postchange_data",
"prechange_data",
"request_id",
"time",
"url",
"user",
"user_name"
]
},
"ObjectPermission": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"enabled": {
"type": "boolean"
},
"object_types": {
"type": "array",
"items": {
"type": "string"
}
},
"actions": {
"type": "array",
"items": {
"type": "string",
"maxLength": 30
},
"description": "The list of actions granted by this permission"
},
"constraints": {
"nullable": true,
"description": "Queryset filter matching the applicable objects of the selected type(s)"
},
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedGroup"
}
},
"users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedUser"
}
}
},
"required": [
"actions",
"display",
"display_url",
"id",
"name",
"object_types",
"url"
]
},
"ObjectPermissionRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"enabled": {
"type": "boolean"
},
"object_types": {
"type": "array",
"items": {
"type": "string"
}
},
"actions": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 30
},
"description": "The list of actions granted by this permission"
},
"constraints": {
"nullable": true,
"description": "Queryset filter matching the applicable objects of the selected type(s)"
},
"groups": {
"type": "array",
"items": {
"type": "integer"
}
},
"users": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"required": [
"actions",
"name",
"object_types"
]
},
"ObjectType": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"app_label": {
"type": "string",
"maxLength": 100
},
"app_name": {
"type": "string",
"readOnly": true
},
"model": {
"type": "string",
"title": "Python model class name",
"maxLength": 100
},
"model_name": {
"type": "string",
"readOnly": true
},
"model_name_plural": {
"type": "string",
"readOnly": true
},
"public": {
"type": "boolean",
"readOnly": true
},
"features": {
"type": "array",
"items": {
"type": "string",
"maxLength": 50
},
"readOnly": true
},
"is_plugin_model": {
"type": "boolean",
"readOnly": true
},
"rest_api_endpoint": {
"type": "string",
"readOnly": true
},
"description": {
"type": "string",
"readOnly": true
}
},
"required": [
"app_label",
"app_name",
"description",
"display",
"features",
"id",
"is_plugin_model",
"model",
"model_name",
"model_name_plural",
"public",
"rest_api_endpoint",
"url"
]
},
"PaginatedASNList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ASN"
}
}
}
},
"PaginatedASNRangeList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ASNRange"
}
}
}
},
"PaginatedAggregateList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Aggregate"
}
}
}
},
"PaginatedBookmarkList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Bookmark"
}
}
}
},
"PaginatedCableList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Cable"
}
}
}
},
"PaginatedCableTerminationList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CableTermination"
}
}
}
},
"PaginatedCircuitGroupAssignmentList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitGroupAssignment"
}
}
}
},
"PaginatedCircuitGroupList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitGroup"
}
}
}
},
"PaginatedCircuitList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Circuit"
}
}
}
},
"PaginatedCircuitTerminationList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitTermination"
}
}
}
},
"PaginatedCircuitTypeList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CircuitType"
}
}
}
},
"PaginatedClusterGroupList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClusterGroup"
}
}
}
},
"PaginatedClusterList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Cluster"
}
}
}
},
"PaginatedClusterTypeList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClusterType"
}
}
}
},
"PaginatedConfigContextList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfigContext"
}
}
}
},
"PaginatedConfigContextProfileList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfigContextProfile"
}
}
}
},
"PaginatedConfigTemplateList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfigTemplate"
}
}
}
},
"PaginatedConsolePortList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsolePort"
}
}
}
},
"PaginatedConsolePortTemplateList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsolePortTemplate"
}
}
}
},
"PaginatedConsoleServerPortList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsoleServerPort"
}
}
}
},
"PaginatedConsoleServerPortTemplateList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsoleServerPortTemplate"
}
}
}
},
"PaginatedContactAssignmentList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactAssignment"
}
}
}
},
"PaginatedContactGroupList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactGroup"
}
}
}
},
"PaginatedContactList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Contact"
}
}
}
},
"PaginatedContactRoleList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactRole"
}
}
}
},
"PaginatedCustomFieldChoiceSetList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFieldChoiceSet"
}
}
}
},
"PaginatedCustomFieldList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomField"
}
}
}
},
"PaginatedCustomLinkList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomLink"
}
}
}
},
"PaginatedDataFileList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataFile"
}
}
}
},
"PaginatedDataSourceList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataSource"
}
}
}
},
"PaginatedDeviceBayList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceBay"
}
}
}
},
"PaginatedDeviceBayTemplateList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceBayTemplate"
}
}
}
},
"PaginatedDeviceRoleList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceRole"
}
}
}
},
"PaginatedDeviceTypeList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceType"
}
}
}
},
"PaginatedDeviceWithConfigContextList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceWithConfigContext"
}
}
}
},
"PaginatedEventRuleList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventRule"
}
}
}
},
"PaginatedExportTemplateList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExportTemplate"
}
}
}
},
"PaginatedFHRPGroupAssignmentList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FHRPGroupAssignment"
}
}
}
},
"PaginatedFHRPGroupList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FHRPGroup"
}
}
}
},
"PaginatedFrontPortList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FrontPort"
}
}
}
},
"PaginatedFrontPortTemplateList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FrontPortTemplate"
}
}
}
},
"PaginatedGroupList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Group"
}
}
}
},
"PaginatedIKEPolicyList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IKEPolicy"
}
}
}
},
"PaginatedIKEProposalList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IKEProposal"
}
}
}
},
"PaginatedIPAddressList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPAddress"
}
}
}
},
"PaginatedIPRangeList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPRange"
}
}
}
},
"PaginatedIPSecPolicyList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPSecPolicy"
}
}
}
},
"PaginatedIPSecProfileList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPSecProfile"
}
}
}
},
"PaginatedIPSecProposalList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPSecProposal"
}
}
}
},
"PaginatedImageAttachmentList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImageAttachment"
}
}
}
},
"PaginatedInterfaceList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Interface"
}
}
}
},
"PaginatedInterfaceTemplateList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InterfaceTemplate"
}
}
}
},
"PaginatedInventoryItemList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InventoryItem"
}
}
}
},
"PaginatedInventoryItemRoleList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InventoryItemRole"
}
}
}
},
"PaginatedInventoryItemTemplateList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InventoryItemTemplate"
}
}
}
},
"PaginatedJobList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Job"
}
}
}
},
"PaginatedJournalEntryList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JournalEntry"
}
}
}
},
"PaginatedL2VPNList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/L2VPN"
}
}
}
},
"PaginatedL2VPNTerminationList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/L2VPNTermination"
}
}
}
},
"PaginatedLocationList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Location"
}
}
}
},
"PaginatedMACAddressList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MACAddress"
}
}
}
},
"PaginatedManufacturerList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Manufacturer"
}
}
}
},
"PaginatedModuleBayList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModuleBay"
}
}
}
},
"PaginatedModuleBayTemplateList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModuleBayTemplate"
}
}
}
},
"PaginatedModuleList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Module"
}
}
}
},
"PaginatedModuleTypeList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModuleType"
}
}
}
},
"PaginatedModuleTypeProfileList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModuleTypeProfile"
}
}
}
},
"PaginatedNotificationGroupList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotificationGroup"
}
}
}
},
"PaginatedNotificationList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Notification"
}
}
}
},
"PaginatedObjectChangeList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ObjectChange"
}
}
}
},
"PaginatedObjectPermissionList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ObjectPermission"
}
}
}
},
"PaginatedObjectTypeList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ObjectType"
}
}
}
},
"PaginatedPlatformList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Platform"
}
}
}
},
"PaginatedPowerFeedList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerFeed"
}
}
}
},
"PaginatedPowerOutletList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerOutlet"
}
}
}
},
"PaginatedPowerOutletTemplateList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerOutletTemplate"
}
}
}
},
"PaginatedPowerPanelList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerPanel"
}
}
}
},
"PaginatedPowerPortList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerPort"
}
}
}
},
"PaginatedPowerPortTemplateList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PowerPortTemplate"
}
}
}
},
"PaginatedPrefixList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Prefix"
}
}
}
},
"PaginatedProviderAccountList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderAccount"
}
}
}
},
"PaginatedProviderList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Provider"
}
}
}
},
"PaginatedProviderNetworkList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderNetwork"
}
}
}
},
"PaginatedRIRList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RIR"
}
}
}
},
"PaginatedRackList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Rack"
}
}
}
},
"PaginatedRackReservationList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RackReservation"
}
}
}
},
"PaginatedRackRoleList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RackRole"
}
}
}
},
"PaginatedRackTypeList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RackType"
}
}
}
},
"PaginatedRackUnitList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RackUnit"
}
}
}
},
"PaginatedRearPortList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RearPort"
}
}
}
},
"PaginatedRearPortTemplateList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RearPortTemplate"
}
}
}
},
"PaginatedRegionList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Region"
}
}
}
},
"PaginatedRoleList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Role"
}
}
}
},
"PaginatedRouteTargetList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RouteTarget"
}
}
}
},
"PaginatedSavedFilterList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SavedFilter"
}
}
}
},
"PaginatedScriptList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Script"
}
}
}
},
"PaginatedServiceList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Service"
}
}
}
},
"PaginatedServiceTemplateList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceTemplate"
}
}
}
},
"PaginatedSiteGroupList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SiteGroup"
}
}
}
},
"PaginatedSiteList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Site"
}
}
}
},
"PaginatedSubscriptionList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Subscription"
}
}
}
},
"PaginatedTableConfigList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TableConfig"
}
}
}
},
"PaginatedTagList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Tag"
}
}
}
},
"PaginatedTaggedItemList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaggedItem"
}
}
}
},
"PaginatedTenantGroupList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TenantGroup"
}
}
}
},
"PaginatedTenantList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Tenant"
}
}
}
},
"PaginatedTokenList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Token"
}
}
}
},
"PaginatedTunnelGroupList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TunnelGroup"
}
}
}
},
"PaginatedTunnelList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Tunnel"
}
}
}
},
"PaginatedTunnelTerminationList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TunnelTermination"
}
}
}
},
"PaginatedUserList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/User"
}
}
}
},
"PaginatedVLANGroupList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VLANGroup"
}
}
}
},
"PaginatedVLANList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VLAN"
}
}
}
},
"PaginatedVLANTranslationPolicyList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VLANTranslationPolicy"
}
}
}
},
"PaginatedVLANTranslationRuleList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VLANTranslationRule"
}
}
}
},
"PaginatedVMInterfaceList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VMInterface"
}
}
}
},
"PaginatedVRFList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VRF"
}
}
}
},
"PaginatedVirtualChassisList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualChassis"
}
}
}
},
"PaginatedVirtualCircuitList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualCircuit"
}
}
}
},
"PaginatedVirtualCircuitTerminationList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualCircuitTermination"
}
}
}
},
"PaginatedVirtualCircuitTypeList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualCircuitType"
}
}
}
},
"PaginatedVirtualDeviceContextList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualDeviceContext"
}
}
}
},
"PaginatedVirtualDiskList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualDisk"
}
}
}
},
"PaginatedVirtualMachineWithConfigContextList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VirtualMachineWithConfigContext"
}
}
}
},
"PaginatedWebhookList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Webhook"
}
}
}
},
"PaginatedWirelessLANGroupList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WirelessLANGroup"
}
}
}
},
"PaginatedWirelessLANList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WirelessLAN"
}
}
}
},
"PaginatedWirelessLinkList": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WirelessLink"
}
}
}
},
"PatchedASNRangeRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"rir": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefRIRRequest"
}
]
},
"start": {
"type": "integer",
"maximum": 4294967295,
"minimum": 1,
"format": "int64"
},
"end": {
"type": "integer",
"maximum": 4294967295,
"minimum": 1,
"format": "int64"
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedASNRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"asn": {
"type": "integer",
"maximum": 4294967295,
"minimum": 1,
"format": "int64",
"description": "16- or 32-bit autonomous system number"
},
"rir": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefRIRRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedBookmarkRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"object_type": {
"type": "string"
},
"object_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64"
},
"user": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefUserRequest"
}
]
}
}
},
"PatchedCableTerminationRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"cable": {
"type": "integer"
},
"cable_end": {
"enum": [
"A",
"B"
],
"type": "string",
"description": "* `A` - A\n* `B` - B",
"x-spec-enum-id": "1db84f9b93b261c8",
"title": "End"
},
"termination_type": {
"type": "string"
},
"termination_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64"
}
}
},
"PatchedCircuitGroupRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedCircuitTerminationRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"circuit": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefCircuitRequest"
}
]
},
"term_side": {
"enum": [
"A",
"Z"
],
"type": "string",
"description": "* `A` - A\n* `Z` - Z",
"x-spec-enum-id": "95b8fcc737f355d0",
"title": "Termination side"
},
"termination_type": {
"type": "string",
"nullable": true
},
"termination_id": {
"type": "integer",
"nullable": true
},
"port_speed": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"title": "Port speed (Kbps)",
"description": "Physical circuit speed"
},
"upstream_speed": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"title": "Upstream speed (Kbps)",
"description": "Upstream speed, if different from port speed"
},
"xconnect_id": {
"type": "string",
"title": "Cross-connect ID",
"description": "ID of the local cross-connect",
"maxLength": 50
},
"pp_info": {
"type": "string",
"title": "Patch panel/port(s)",
"description": "Patch panel ID and port number(s)",
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"mark_connected": {
"type": "boolean",
"description": "Treat as if a cable is connected"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedCircuitTypeRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"color": {
"type": "string",
"pattern": "^[0-9a-f]{6}$",
"maxLength": 6
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedClusterGroupRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedClusterTypeRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedConfigContextProfileRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"schema": {
"nullable": true,
"description": "A JSON schema specifying the structure of the context data for this profile"
},
"tags": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"comments": {
"type": "string"
},
"data_source": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDataSourceRequest"
}
]
}
}
},
"PatchedConfigContextRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"weight": {
"type": "integer",
"maximum": 32767,
"minimum": 0
},
"profile": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefConfigContextProfileRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"is_active": {
"type": "boolean"
},
"regions": {
"type": "array",
"items": {
"type": "integer"
}
},
"site_groups": {
"type": "array",
"items": {
"type": "integer"
}
},
"sites": {
"type": "array",
"items": {
"type": "integer"
}
},
"locations": {
"type": "array",
"items": {
"type": "integer"
}
},
"device_types": {
"type": "array",
"items": {
"type": "integer"
}
},
"roles": {
"type": "array",
"items": {
"type": "integer"
}
},
"platforms": {
"type": "array",
"items": {
"type": "integer"
}
},
"cluster_types": {
"type": "array",
"items": {
"type": "integer"
}
},
"cluster_groups": {
"type": "array",
"items": {
"type": "integer"
}
},
"clusters": {
"type": "array",
"items": {
"type": "integer"
}
},
"tenant_groups": {
"type": "array",
"items": {
"type": "integer"
}
},
"tenants": {
"type": "array",
"items": {
"type": "integer"
}
},
"tags": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"data_source": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDataSourceRequest"
}
]
},
"data": {}
}
},
"PatchedConfigTemplateRequest": {
"type": "object",
"description": "Introduces support for Tag assignment. Adds `tags` serialization, and handles tag assignment\non create() and update().",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"environment_params": {
"nullable": true,
"title": "Environment parameters",
"description": "Any additional parameters to pass when constructing the Jinja environment"
},
"template_code": {
"type": "string",
"minLength": 1,
"description": "Jinja template code."
},
"mime_type": {
"type": "string",
"description": "Defaults to text/plain; charset=utf-8",
"maxLength": 50
},
"file_name": {
"type": "string",
"description": "Filename to give to the rendered export file",
"maxLength": 200
},
"file_extension": {
"type": "string",
"description": "Extension to append to the rendered filename",
"maxLength": 15
},
"as_attachment": {
"type": "boolean",
"description": "Download file as attachment"
},
"data_source": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDataSourceRequest"
}
]
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
}
}
},
"PatchedContactRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"groups": {
"type": "array",
"items": {
"type": "integer"
}
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"title": {
"type": "string",
"maxLength": 100
},
"phone": {
"type": "string",
"maxLength": 50
},
"email": {
"type": "string",
"format": "email",
"maxLength": 254
},
"address": {
"type": "string",
"maxLength": 200
},
"link": {
"type": "string",
"format": "uri",
"maxLength": 200
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedContactRoleRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedCustomLinkRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"object_types": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"enabled": {
"type": "boolean"
},
"link_text": {
"type": "string",
"minLength": 1,
"description": "Jinja2 template code for link text"
},
"link_url": {
"type": "string",
"minLength": 1,
"description": "Jinja2 template code for link URL"
},
"weight": {
"type": "integer",
"maximum": 32767,
"minimum": 0
},
"group_name": {
"type": "string",
"description": "Links with the same group will appear as a dropdown menu",
"maxLength": 50
},
"button_class": {
"enum": [
"default",
"blue",
"indigo",
"purple",
"pink",
"red",
"orange",
"yellow",
"green",
"teal",
"cyan",
"gray",
"black",
"white",
"ghost-dark"
],
"type": "string",
"x-spec-enum-id": "ee8e5bb1ccdcdb19",
"description": "The class of the first link in a group will be used for the dropdown button\n\n* `default` - Default\n* `blue` - Blue\n* `indigo` - Indigo\n* `purple` - Purple\n* `pink` - Pink\n* `red` - Red\n* `orange` - Orange\n* `yellow` - Yellow\n* `green` - Green\n* `teal` - Teal\n* `cyan` - Cyan\n* `gray` - Gray\n* `black` - Black\n* `white` - White\n* `ghost-dark` - Link"
},
"new_window": {
"type": "boolean",
"description": "Force link to open in a new window"
}
}
},
"PatchedDashboardRequest": {
"type": "object",
"properties": {
"layout": {},
"config": {}
}
},
"PatchedDeviceBayRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"device": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDeviceRequest"
}
]
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"description": {
"type": "string",
"maxLength": 200
},
"installed_device": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefDeviceRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedDeviceBayTemplateRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"device_type": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDeviceTypeRequest"
}
]
},
"name": {
"type": "string",
"minLength": 1,
"description": "{module} is accepted as a substitution for the module bay position when attached to a module type.",
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"description": {
"type": "string",
"maxLength": 200
}
}
},
"PatchedExportTemplateRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"object_types": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"environment_params": {
"nullable": true,
"title": "Environment parameters",
"description": "Any additional parameters to pass when constructing the Jinja environment"
},
"template_code": {
"type": "string",
"minLength": 1,
"description": "Jinja template code."
},
"mime_type": {
"type": "string",
"description": "Defaults to text/plain; charset=utf-8",
"maxLength": 50
},
"file_name": {
"type": "string",
"description": "Filename to give to the rendered export file",
"maxLength": 200
},
"file_extension": {
"type": "string",
"description": "Extension to append to the rendered filename",
"maxLength": 15
},
"as_attachment": {
"type": "boolean",
"description": "Download file as attachment"
},
"data_source": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDataSourceRequest"
}
]
}
}
},
"PatchedFHRPGroupAssignmentRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"group": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefFHRPGroupRequest"
}
]
},
"interface_type": {
"type": "string"
},
"interface_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64"
},
"priority": {
"type": "integer",
"maximum": 255,
"minimum": 0
}
}
},
"PatchedFHRPGroupRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"maxLength": 100
},
"protocol": {
"enum": [
"vrrp2",
"vrrp3",
"carp",
"clusterxl",
"hsrp",
"glbp",
"other"
],
"type": "string",
"description": "* `vrrp2` - VRRPv2\n* `vrrp3` - VRRPv3\n* `carp` - CARP\n* `clusterxl` - ClusterXL\n* `hsrp` - HSRP\n* `glbp` - GLBP\n* `other` - Other",
"x-spec-enum-id": "40dc831c689b4b78"
},
"group_id": {
"type": "integer",
"maximum": 32767,
"minimum": 0
},
"auth_type": {
"enum": [
"plaintext",
"md5",
"",
null
],
"type": "string",
"description": "* `plaintext` - Plaintext\n* `md5` - MD5",
"x-spec-enum-id": "12b9faea3a45bf37",
"nullable": true,
"title": "Authentication type"
},
"auth_key": {
"type": "string",
"title": "Authentication key",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedGroupRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 150
},
"description": {
"type": "string",
"maxLength": 200
},
"permissions": {
"type": "array",
"items": {
"type": "integer"
}
}
}
},
"PatchedImageAttachmentRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"object_type": {
"type": "string"
},
"object_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64"
},
"name": {
"type": "string",
"maxLength": 50
},
"image": {
"type": "string",
"format": "binary"
},
"description": {
"type": "string",
"maxLength": 200
}
}
},
"PatchedInventoryItemRoleRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"color": {
"type": "string",
"minLength": 1,
"pattern": "^[0-9a-f]{6}$",
"maxLength": 6
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedInventoryItemTemplateRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"device_type": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDeviceTypeRequest"
}
]
},
"parent": {
"type": "integer",
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"description": "{module} is accepted as a substitution for the module bay position when attached to a module type.",
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"role": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefInventoryItemRoleRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"manufacturer": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefManufacturerRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"part_id": {
"type": "string",
"description": "Manufacturer-assigned part identifier",
"maxLength": 50
},
"description": {
"type": "string",
"maxLength": 200
},
"component_type": {
"type": "string",
"nullable": true
},
"component_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64",
"nullable": true
}
}
},
"PatchedL2VPNTerminationRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"l2vpn": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefL2VPNRequest"
}
]
},
"assigned_object_type": {
"type": "string"
},
"assigned_object_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedMACAddressRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"mac_address": {
"type": "string"
},
"assigned_object_type": {
"type": "string",
"nullable": true
},
"assigned_object_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedManufacturerRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedModuleBayRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"device": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDeviceRequest"
}
]
},
"module": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"installed_module": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"position": {
"type": "string",
"description": "Identifier to reference when renaming installed components",
"maxLength": 30
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedModuleBayTemplateRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"device_type": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefDeviceTypeRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"module_type": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleTypeRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"description": "{module} is accepted as a substitution for the module bay position when attached to a module type.",
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"position": {
"type": "string",
"description": "Identifier to reference when renaming installed components",
"maxLength": 30
},
"description": {
"type": "string",
"maxLength": 200
}
}
},
"PatchedModuleTypeProfileRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"schema": {
"nullable": true
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedNotificationGroupRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"groups": {
"type": "array",
"items": {
"type": "integer"
}
},
"users": {
"type": "array",
"items": {
"type": "integer"
}
}
}
},
"PatchedNotificationRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"object_type": {
"type": "string"
},
"object_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64"
},
"user": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefUserRequest"
}
]
},
"read": {
"type": "string",
"format": "date-time",
"nullable": true
},
"event_type": {
"enum": [
"object_created",
"object_updated",
"object_deleted",
"job_started",
"job_completed",
"job_failed",
"job_errored"
],
"type": "string",
"description": "* `object_created` - Object created\n* `object_updated` - Object updated\n* `object_deleted` - Object deleted\n* `job_started` - Job started\n* `job_completed` - Job completed\n* `job_failed` - Job failed\n* `job_errored` - Job errored",
"x-spec-enum-id": "80d172232f4af424",
"title": "Event"
}
}
},
"PatchedObjectPermissionRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"enabled": {
"type": "boolean"
},
"object_types": {
"type": "array",
"items": {
"type": "string"
}
},
"actions": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 30
},
"description": "The list of actions granted by this permission"
},
"constraints": {
"nullable": true,
"description": "Queryset filter matching the applicable objects of the selected type(s)"
},
"groups": {
"type": "array",
"items": {
"type": "integer"
}
},
"users": {
"type": "array",
"items": {
"type": "integer"
}
}
}
},
"PatchedPowerPanelRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"site": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefSiteRequest"
}
]
},
"location": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefLocationRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedProviderAccountRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"provider": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefProviderRequest"
}
]
},
"name": {
"type": "string",
"default": "",
"maxLength": 100
},
"account": {
"type": "string",
"minLength": 1,
"title": "Account ID",
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedProviderNetworkRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"provider": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefProviderRequest"
}
]
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"service_id": {
"type": "string",
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedProviderRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"description": "Full name of the provider",
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"accounts": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"asns": {
"type": "array",
"items": {
"type": "integer"
}
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedRIRRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"is_private": {
"type": "boolean",
"title": "Private",
"description": "IP space managed by this RIR is considered private"
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedRackRoleRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"color": {
"type": "string",
"minLength": 1,
"pattern": "^[0-9a-f]{6}$",
"maxLength": 6
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedRoleRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"weight": {
"type": "integer",
"maximum": 32767,
"minimum": 0
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedRouteTargetRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"description": "Route target value (formatted in accordance with RFC 4360)",
"maxLength": 21
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedSavedFilterRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"object_types": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
},
"user": {
"type": "integer",
"nullable": true
},
"weight": {
"type": "integer",
"maximum": 32767,
"minimum": 0
},
"enabled": {
"type": "boolean"
},
"shared": {
"type": "boolean"
},
"parameters": {}
}
},
"PatchedScriptInputRequest": {
"type": "object",
"properties": {
"data": {},
"commit": {
"type": "boolean"
},
"schedule_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
"interval": {
"type": "integer",
"nullable": true
}
}
},
"PatchedSubscriptionRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"object_type": {
"type": "string"
},
"object_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64"
},
"user": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefUserRequest"
}
]
}
}
},
"PatchedTableConfigRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"object_type": {
"type": "string"
},
"table": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"user": {
"type": "integer",
"nullable": true
},
"weight": {
"type": "integer",
"maximum": 32767,
"minimum": 0
},
"enabled": {
"type": "boolean"
},
"shared": {
"type": "boolean"
},
"columns": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
}
},
"ordering": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"nullable": true
}
}
},
"PatchedTagRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"pattern": "^[-\\w]+$",
"maxLength": 100
},
"color": {
"type": "string",
"minLength": 1,
"pattern": "^[0-9a-f]{6}$",
"maxLength": 6
},
"description": {
"type": "string",
"maxLength": 200
},
"weight": {
"type": "integer",
"maximum": 32767,
"minimum": 0
},
"object_types": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"PatchedTenantRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"group": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantGroupRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedTokenRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"user": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefUserRequest"
}
]
},
"expires": {
"type": "string",
"format": "date-time",
"nullable": true
},
"last_used": {
"type": "string",
"format": "date-time",
"nullable": true
},
"key": {
"type": "string",
"writeOnly": true,
"maxLength": 40,
"minLength": 40
},
"write_enabled": {
"type": "boolean",
"description": "Permit create/update/delete operations using this key"
},
"description": {
"type": "string",
"maxLength": 200
}
}
},
"PatchedTunnelGroupRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedUserRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"username": {
"type": "string",
"minLength": 1,
"description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
"pattern": "^[\\w.@+-]+$",
"maxLength": 150
},
"password": {
"type": "string",
"writeOnly": true,
"minLength": 1,
"maxLength": 128
},
"first_name": {
"type": "string",
"maxLength": 150
},
"last_name": {
"type": "string",
"maxLength": 150
},
"email": {
"type": "string",
"format": "email",
"title": "Email address",
"maxLength": 254
},
"is_staff": {
"type": "boolean",
"title": "Staff status",
"description": "Designates whether the user can log into this admin site."
},
"is_active": {
"type": "boolean",
"title": "Active",
"description": "Designates whether this user should be treated as active. Unselect this instead of deleting accounts."
},
"date_joined": {
"type": "string",
"format": "date-time"
},
"last_login": {
"type": "string",
"format": "date-time",
"nullable": true
},
"groups": {
"type": "array",
"items": {
"type": "integer"
}
},
"permissions": {
"type": "array",
"items": {
"type": "integer"
}
}
}
},
"PatchedVLANGroupRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"scope_type": {
"type": "string",
"nullable": true
},
"scope_id": {
"type": "integer",
"nullable": true
},
"vid_ranges": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IntegerRangeRequest"
}
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedVLANTranslationPolicyRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
}
}
},
"PatchedVLANTranslationRuleRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"policy": {
"type": "integer"
},
"local_vid": {
"type": "integer",
"maximum": 4094,
"minimum": 1,
"title": "Local VLAN ID",
"description": "Numeric VLAN ID (1-4094)"
},
"remote_vid": {
"type": "integer",
"maximum": 4094,
"minimum": 1,
"title": "Remote VLAN ID",
"description": "Numeric VLAN ID (1-4094)"
},
"description": {
"type": "string",
"maxLength": 200
}
}
},
"PatchedVRFRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"rd": {
"type": "string",
"nullable": true,
"title": "Route distinguisher",
"description": "Unique route distinguisher (as defined in RFC 4364)",
"maxLength": 21
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"enforce_unique": {
"type": "boolean",
"title": "Enforce unique space",
"description": "Prevent duplicate prefixes/IP addresses within this VRF"
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"import_targets": {
"type": "array",
"items": {
"type": "integer"
}
},
"export_targets": {
"type": "array",
"items": {
"type": "integer"
}
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedVirtualCircuitTypeRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"color": {
"type": "string",
"pattern": "^[0-9a-f]{6}$",
"maxLength": 6
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedVirtualDiskRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"virtual_machine": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefVirtualMachineRequest"
}
]
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"description": {
"type": "string",
"maxLength": 200
},
"size": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"title": "Size (MB)"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedWebhookRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 150
},
"description": {
"type": "string",
"maxLength": 200
},
"payload_url": {
"type": "string",
"minLength": 1,
"title": "URL",
"description": "This URL will be called using the HTTP method defined when the webhook is called. Jinja2 template processing is supported with the same context as the request body.",
"maxLength": 500
},
"http_method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"type": "string",
"description": "* `GET` - GET\n* `POST` - POST\n* `PUT` - PUT\n* `PATCH` - PATCH\n* `DELETE` - DELETE",
"x-spec-enum-id": "a12018571a034921"
},
"http_content_type": {
"type": "string",
"minLength": 1,
"description": "The complete list of official content types is available here.",
"maxLength": 100
},
"additional_headers": {
"type": "string",
"description": "User-supplied HTTP headers to be sent with the request in addition to the HTTP content type. Headers should be defined in the format Name: Value. Jinja2 template processing is supported with the same context as the request body (below)."
},
"body_template": {
"type": "string",
"description": "Jinja2 template for a custom request body. If blank, a JSON object representing the change will be included. Available context data includes: event, model, timestamp, username, request_id, and data."
},
"secret": {
"type": "string",
"description": "When provided, the request will include a X-Hook-Signature header containing a HMAC hex digest of the payload body using the secret as the key. The secret is not transmitted in the request.",
"maxLength": 255
},
"ssl_verification": {
"type": "boolean",
"description": "Enable SSL certificate verification. Disable with caution!"
},
"ca_file_path": {
"type": "string",
"nullable": true,
"description": "The specific CA certificate file to use for SSL verification. Leave blank to use the system defaults.",
"maxLength": 4096
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
}
}
},
"PatchedWritableAggregateRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"prefix": {
"type": "string",
"minLength": 1
},
"rir": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefRIRRequest"
}
]
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"date_added": {
"type": "string",
"format": "date",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedWritableCableRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"type": {
"enum": [
"cat3",
"cat5",
"cat5e",
"cat6",
"cat6a",
"cat7",
"cat7a",
"cat8",
"dac-active",
"dac-passive",
"mrj21-trunk",
"coaxial",
"mmf",
"mmf-om1",
"mmf-om2",
"mmf-om3",
"mmf-om4",
"mmf-om5",
"smf",
"smf-os1",
"smf-os2",
"aoc",
"usb",
"power",
"",
null
],
"type": "string",
"description": "* `cat3` - CAT3\n* `cat5` - CAT5\n* `cat5e` - CAT5e\n* `cat6` - CAT6\n* `cat6a` - CAT6a\n* `cat7` - CAT7\n* `cat7a` - CAT7a\n* `cat8` - CAT8\n* `dac-active` - Direct Attach Copper (Active)\n* `dac-passive` - Direct Attach Copper (Passive)\n* `mrj21-trunk` - MRJ21 Trunk\n* `coaxial` - Coaxial\n* `mmf` - Multimode Fiber\n* `mmf-om1` - Multimode Fiber (OM1)\n* `mmf-om2` - Multimode Fiber (OM2)\n* `mmf-om3` - Multimode Fiber (OM3)\n* `mmf-om4` - Multimode Fiber (OM4)\n* `mmf-om5` - Multimode Fiber (OM5)\n* `smf` - Singlemode Fiber\n* `smf-os1` - Singlemode Fiber (OS1)\n* `smf-os2` - Singlemode Fiber (OS2)\n* `aoc` - Active Optical Cabling (AOC)\n* `usb` - USB\n* `power` - Power",
"x-spec-enum-id": "7b11d524b2b1a7ef",
"nullable": true
},
"a_terminations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GenericObjectRequest"
}
},
"b_terminations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GenericObjectRequest"
}
},
"status": {
"enum": [
"connected",
"planned",
"decommissioning"
],
"type": "string",
"description": "* `connected` - Connected\n* `planned` - Planned\n* `decommissioning` - Decommissioning",
"x-spec-enum-id": "fbc2f302c08be50d"
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"label": {
"type": "string",
"maxLength": 100
},
"color": {
"type": "string",
"pattern": "^[0-9a-f]{6}$",
"maxLength": 6
},
"length": {
"type": "number",
"format": "double",
"maximum": 1000000,
"minimum": -1000000,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true
},
"length_unit": {
"enum": [
"km",
"m",
"cm",
"mi",
"ft",
"in",
"",
null
],
"type": "string",
"description": "* `km` - Kilometers\n* `m` - Meters\n* `cm` - Centimeters\n* `mi` - Miles\n* `ft` - Feet\n* `in` - Inches",
"x-spec-enum-id": "e64ce3a2c5997172",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedWritableCircuitGroupAssignmentRequest": {
"type": "object",
"description": "Base serializer for group assignments under CircuitSerializer.",
"properties": {
"group": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefCircuitGroupRequest"
}
]
},
"member_type": {
"type": "string"
},
"member_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64"
},
"priority": {
"enum": [
"primary",
"secondary",
"tertiary",
"inactive",
"",
null
],
"type": "string",
"description": "* `primary` - Primary\n* `secondary` - Secondary\n* `tertiary` - Tertiary\n* `inactive` - Inactive",
"x-spec-enum-id": "ef3a31644cec7524",
"nullable": true
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
}
}
},
"PatchedWritableCircuitRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"cid": {
"type": "string",
"minLength": 1,
"title": "Circuit ID",
"description": "Unique circuit ID",
"maxLength": 100
},
"provider": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefProviderRequest"
}
]
},
"provider_account": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefProviderAccountRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"type": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefCircuitTypeRequest"
}
]
},
"status": {
"enum": [
"planned",
"provisioning",
"active",
"offline",
"deprovisioning",
"decommissioned"
],
"type": "string",
"description": "* `planned` - Planned\n* `provisioning` - Provisioning\n* `active` - Active\n* `offline` - Offline\n* `deprovisioning` - Deprovisioning\n* `decommissioned` - Decommissioned",
"x-spec-enum-id": "63c838134a022200"
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"install_date": {
"type": "string",
"format": "date",
"nullable": true,
"title": "Installed"
},
"termination_date": {
"type": "string",
"format": "date",
"nullable": true,
"title": "Terminates"
},
"commit_rate": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"title": "Commit rate (Kbps)",
"description": "Committed rate"
},
"description": {
"type": "string",
"maxLength": 200
},
"distance": {
"type": "number",
"format": "double",
"maximum": 1000000,
"minimum": -1000000,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true
},
"distance_unit": {
"enum": [
"km",
"m",
"mi",
"ft",
"",
null
],
"type": "string",
"description": "* `km` - Kilometers\n* `m` - Meters\n* `mi` - Miles\n* `ft` - Feet",
"x-spec-enum-id": "53542e7902f946af",
"nullable": true
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"assignments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BriefCircuitGroupAssignmentSerializer_Request"
}
}
}
},
"PatchedWritableClusterRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"type": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefClusterTypeRequest"
}
]
},
"group": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefClusterGroupRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"status": {
"enum": [
"planned",
"staging",
"active",
"decommissioning",
"offline"
],
"type": "string",
"description": "* `planned` - Planned\n* `staging` - Staging\n* `active` - Active\n* `decommissioning` - Decommissioning\n* `offline` - Offline",
"x-spec-enum-id": "79d20a734d0eecbb"
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"scope_type": {
"type": "string",
"nullable": true
},
"scope_id": {
"type": "integer",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedWritableConsolePortRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"device": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDeviceRequest"
}
]
},
"module": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"enum": [
"de-9",
"db-25",
"rj-11",
"rj-12",
"rj-45",
"mini-din-8",
"usb-a",
"usb-b",
"usb-c",
"usb-mini-a",
"usb-mini-b",
"usb-micro-a",
"usb-micro-b",
"usb-micro-ab",
"other",
"",
null
],
"type": "string",
"x-spec-enum-id": "c5f7197b7211818a",
"nullable": true,
"description": "Physical port type\n\n* `de-9` - DE-9\n* `db-25` - DB-25\n* `rj-11` - RJ-11\n* `rj-12` - RJ-12\n* `rj-45` - RJ-45\n* `mini-din-8` - Mini-DIN 8\n* `usb-a` - USB Type A\n* `usb-b` - USB Type B\n* `usb-c` - USB Type C\n* `usb-mini-a` - USB Mini A\n* `usb-mini-b` - USB Mini B\n* `usb-micro-a` - USB Micro A\n* `usb-micro-b` - USB Micro B\n* `usb-micro-ab` - USB Micro AB\n* `other` - Other"
},
"speed": {
"enum": [
1200,
2400,
4800,
9600,
19200,
38400,
57600,
115200,
null
],
"type": "integer",
"x-spec-enum-id": "ab6d9635c131a378",
"nullable": true,
"description": "Port speed in bits per second\n\n* `1200` - 1200 bps\n* `2400` - 2400 bps\n* `4800` - 4800 bps\n* `9600` - 9600 bps\n* `19200` - 19.2 kbps\n* `38400` - 38.4 kbps\n* `57600` - 57.6 kbps\n* `115200` - 115.2 kbps",
"minimum": 0,
"maximum": 2147483647
},
"description": {
"type": "string",
"maxLength": 200
},
"mark_connected": {
"type": "boolean",
"description": "Treat as if a cable is connected"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedWritableConsolePortTemplateRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"device_type": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefDeviceTypeRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"module_type": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleTypeRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"description": "{module} is accepted as a substitution for the module bay position when attached to a module type.",
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"enum": [
"de-9",
"db-25",
"rj-11",
"rj-12",
"rj-45",
"mini-din-8",
"usb-a",
"usb-b",
"usb-c",
"usb-mini-a",
"usb-mini-b",
"usb-micro-a",
"usb-micro-b",
"usb-micro-ab",
"other",
"",
null
],
"type": "string",
"description": "* `de-9` - DE-9\n* `db-25` - DB-25\n* `rj-11` - RJ-11\n* `rj-12` - RJ-12\n* `rj-45` - RJ-45\n* `mini-din-8` - Mini-DIN 8\n* `usb-a` - USB Type A\n* `usb-b` - USB Type B\n* `usb-c` - USB Type C\n* `usb-mini-a` - USB Mini A\n* `usb-mini-b` - USB Mini B\n* `usb-micro-a` - USB Micro A\n* `usb-micro-b` - USB Micro B\n* `usb-micro-ab` - USB Micro AB\n* `other` - Other",
"x-spec-enum-id": "c5f7197b7211818a",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
}
}
},
"PatchedWritableConsoleServerPortRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"device": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDeviceRequest"
}
]
},
"module": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"enum": [
"de-9",
"db-25",
"rj-11",
"rj-12",
"rj-45",
"mini-din-8",
"usb-a",
"usb-b",
"usb-c",
"usb-mini-a",
"usb-mini-b",
"usb-micro-a",
"usb-micro-b",
"usb-micro-ab",
"other",
"",
null
],
"type": "string",
"x-spec-enum-id": "c5f7197b7211818a",
"nullable": true,
"description": "Physical port type\n\n* `de-9` - DE-9\n* `db-25` - DB-25\n* `rj-11` - RJ-11\n* `rj-12` - RJ-12\n* `rj-45` - RJ-45\n* `mini-din-8` - Mini-DIN 8\n* `usb-a` - USB Type A\n* `usb-b` - USB Type B\n* `usb-c` - USB Type C\n* `usb-mini-a` - USB Mini A\n* `usb-mini-b` - USB Mini B\n* `usb-micro-a` - USB Micro A\n* `usb-micro-b` - USB Micro B\n* `usb-micro-ab` - USB Micro AB\n* `other` - Other"
},
"speed": {
"enum": [
1200,
2400,
4800,
9600,
19200,
38400,
57600,
115200,
null
],
"type": "integer",
"x-spec-enum-id": "ab6d9635c131a378",
"nullable": true,
"description": "Port speed in bits per second\n\n* `1200` - 1200 bps\n* `2400` - 2400 bps\n* `4800` - 4800 bps\n* `9600` - 9600 bps\n* `19200` - 19.2 kbps\n* `38400` - 38.4 kbps\n* `57600` - 57.6 kbps\n* `115200` - 115.2 kbps",
"minimum": 0,
"maximum": 2147483647
},
"description": {
"type": "string",
"maxLength": 200
},
"mark_connected": {
"type": "boolean",
"description": "Treat as if a cable is connected"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedWritableConsoleServerPortTemplateRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"device_type": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefDeviceTypeRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"module_type": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleTypeRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"description": "{module} is accepted as a substitution for the module bay position when attached to a module type.",
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"enum": [
"de-9",
"db-25",
"rj-11",
"rj-12",
"rj-45",
"mini-din-8",
"usb-a",
"usb-b",
"usb-c",
"usb-mini-a",
"usb-mini-b",
"usb-micro-a",
"usb-micro-b",
"usb-micro-ab",
"other",
"",
null
],
"type": "string",
"description": "* `de-9` - DE-9\n* `db-25` - DB-25\n* `rj-11` - RJ-11\n* `rj-12` - RJ-12\n* `rj-45` - RJ-45\n* `mini-din-8` - Mini-DIN 8\n* `usb-a` - USB Type A\n* `usb-b` - USB Type B\n* `usb-c` - USB Type C\n* `usb-mini-a` - USB Mini A\n* `usb-mini-b` - USB Mini B\n* `usb-micro-a` - USB Micro A\n* `usb-micro-b` - USB Micro B\n* `usb-micro-ab` - USB Micro AB\n* `other` - Other",
"x-spec-enum-id": "c5f7197b7211818a",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
}
}
},
"PatchedWritableContactAssignmentRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"object_type": {
"type": "string"
},
"object_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64"
},
"contact": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefContactRequest"
}
]
},
"role": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefContactRoleRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"priority": {
"enum": [
"primary",
"secondary",
"tertiary",
"inactive",
"",
null
],
"type": "string",
"description": "* `primary` - Primary\n* `secondary` - Secondary\n* `tertiary` - Tertiary\n* `inactive` - Inactive",
"x-spec-enum-id": "ef3a31644cec7524",
"nullable": true
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedWritableContactGroupRequest": {
"type": "object",
"description": "Extends PrimaryModelSerializer to include MPTT support.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"parent": {
"type": "integer",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"comments": {
"type": "string"
}
}
},
"PatchedWritableCustomFieldChoiceSetRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"base_choices": {
"enum": [
"IATA",
"ISO_3166",
"UN_LOCODE",
"",
null
],
"type": "string",
"x-spec-enum-id": "cf0efb5195f85007",
"nullable": true,
"description": "Base set of predefined choices (optional)\n\n* `IATA` - IATA (Airport codes)\n* `ISO_3166` - ISO 3166 (Country codes)\n* `UN_LOCODE` - UN/LOCODE (Location codes)"
},
"extra_choices": {
"type": "array",
"items": {
"type": "array",
"items": {},
"maxItems": 2,
"minItems": 2
}
},
"order_alphabetically": {
"type": "boolean",
"description": "Choices are automatically ordered alphabetically"
}
}
},
"PatchedWritableCustomFieldRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"object_types": {
"type": "array",
"items": {
"type": "string"
}
},
"type": {
"enum": [
"text",
"longtext",
"integer",
"decimal",
"boolean",
"date",
"datetime",
"url",
"json",
"select",
"multiselect",
"object",
"multiobject"
],
"type": "string",
"x-spec-enum-id": "22e3a64138d10046",
"description": "The type of data this custom field holds\n\n* `text` - Text\n* `longtext` - Text (long)\n* `integer` - Integer\n* `decimal` - Decimal\n* `boolean` - Boolean (true/false)\n* `date` - Date\n* `datetime` - Date & time\n* `url` - URL\n* `json` - JSON\n* `select` - Selection\n* `multiselect` - Multiple selection\n* `object` - Object\n* `multiobject` - Multiple objects"
},
"related_object_type": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"description": "Internal field name",
"pattern": "^[a-z0-9_]+$",
"maxLength": 50
},
"label": {
"type": "string",
"description": "Name of the field as displayed to users (if not provided, 'the field's name will be used)",
"maxLength": 50
},
"group_name": {
"type": "string",
"description": "Custom fields within the same group will be displayed together",
"maxLength": 50
},
"description": {
"type": "string",
"maxLength": 200
},
"required": {
"type": "boolean",
"description": "This field is required when creating new objects or editing an existing object."
},
"unique": {
"type": "boolean",
"title": "Must be unique",
"description": "The value of this field must be unique for the assigned object"
},
"search_weight": {
"type": "integer",
"maximum": 32767,
"minimum": 0,
"description": "Weighting for search. Lower values are considered more important. Fields with a search weight of zero will be ignored."
},
"filter_logic": {
"enum": [
"disabled",
"loose",
"exact"
],
"type": "string",
"x-spec-enum-id": "a958350ae21c10ee",
"description": "Loose matches any instance of a given string; exact matches the entire field.\n\n* `disabled` - Disabled\n* `loose` - Loose\n* `exact` - Exact"
},
"ui_visible": {
"enum": [
"always",
"if-set",
"hidden"
],
"type": "string",
"x-spec-enum-id": "cd2cf94af56de747",
"description": "Specifies whether the custom field is displayed in the UI\n\n* `always` - Always\n* `if-set` - If set\n* `hidden` - Hidden"
},
"ui_editable": {
"enum": [
"yes",
"no",
"hidden"
],
"type": "string",
"x-spec-enum-id": "1065673147e26bb5",
"description": "Specifies whether the custom field value can be edited in the UI\n\n* `yes` - Yes\n* `no` - No\n* `hidden` - Hidden"
},
"is_cloneable": {
"type": "boolean",
"description": "Replicate this value when cloning objects"
},
"default": {
"nullable": true,
"description": "Default value for the field (must be a JSON value). Encapsulate strings with double quotes (e.g. \"Foo\")."
},
"related_object_filter": {
"nullable": true,
"description": "Filter the object selection choices using a query_params dict (must be a JSON value).Encapsulate strings with double quotes (e.g. \"Foo\")."
},
"weight": {
"type": "integer",
"maximum": 32767,
"minimum": 0,
"title": "Display weight",
"description": "Fields with higher weights appear lower in a form."
},
"validation_minimum": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"format": "int64",
"nullable": true,
"title": "Minimum value",
"description": "Minimum allowed value (for numeric fields)"
},
"validation_maximum": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"format": "int64",
"nullable": true,
"title": "Maximum value",
"description": "Maximum allowed value (for numeric fields)"
},
"validation_regex": {
"type": "string",
"description": "Regular expression to enforce on text field values. Use ^ and $ to force matching of entire string. For example, ^[A-Z]{3}$ will limit values to exactly three uppercase letters.",
"maxLength": 500
},
"choice_set": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefCustomFieldChoiceSetRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"comments": {
"type": "string"
}
}
},
"PatchedWritableDataSourceRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"type": {
"type": "string",
"minLength": 1,
"maxLength": 50
},
"source_url": {
"type": "string",
"minLength": 1,
"title": "URL",
"maxLength": 200
},
"enabled": {
"type": "boolean"
},
"description": {
"type": "string",
"maxLength": 200
},
"sync_interval": {
"enum": [
1,
60,
720,
1440,
10080,
43200,
null
],
"type": "integer",
"description": "* `1` - Minutely\n* `60` - Hourly\n* `720` - 12 hours\n* `1440` - Daily\n* `10080` - Weekly\n* `43200` - 30 days",
"x-spec-enum-id": "2e9f2567ecd93fbe",
"nullable": true,
"minimum": 0,
"maximum": 32767
},
"parameters": {
"nullable": true
},
"ignore_rules": {
"type": "string",
"description": "Patterns (one per line) matching files to ignore when syncing"
},
"comments": {
"type": "string"
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedWritableDeviceRoleRequest": {
"type": "object",
"description": "Extends PrimaryModelSerializer to include MPTT support.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"color": {
"type": "string",
"minLength": 1,
"pattern": "^[0-9a-f]{6}$",
"maxLength": 6
},
"vm_role": {
"type": "boolean",
"description": "Virtual machines may be assigned to this role"
},
"config_template": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefConfigTemplateRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"parent": {
"type": "integer",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"comments": {
"type": "string"
}
}
},
"PatchedWritableDeviceTypeRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"manufacturer": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefManufacturerRequest"
}
]
},
"default_platform": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefPlatformRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"model": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"part_number": {
"type": "string",
"description": "Discrete part number (optional)",
"maxLength": 50
},
"u_height": {
"type": "number",
"format": "double",
"maximum": 1000,
"minimum": 0.0,
"exclusiveMaximum": true,
"default": 1.0,
"title": "Position (U)"
},
"exclude_from_utilization": {
"type": "boolean",
"description": "Devices of this type are excluded when calculating rack utilization."
},
"is_full_depth": {
"type": "boolean",
"description": "Device consumes both front and rear rack faces."
},
"subdevice_role": {
"enum": [
"parent",
"child",
"",
null
],
"type": "string",
"x-spec-enum-id": "d10d91f690a856c2",
"nullable": true,
"title": "Parent/child status",
"description": "Parent devices house child devices in device bays. Leave blank if this device type is neither a parent nor a child.\n\n* `parent` - Parent\n* `child` - Child"
},
"airflow": {
"enum": [
"front-to-rear",
"rear-to-front",
"left-to-right",
"right-to-left",
"side-to-rear",
"rear-to-side",
"bottom-to-top",
"top-to-bottom",
"passive",
"mixed",
"",
null
],
"type": "string",
"description": "* `front-to-rear` - Front to rear\n* `rear-to-front` - Rear to front\n* `left-to-right` - Left to right\n* `right-to-left` - Right to left\n* `side-to-rear` - Side to rear\n* `rear-to-side` - Rear to side\n* `bottom-to-top` - Bottom to top\n* `top-to-bottom` - Top to bottom\n* `passive` - Passive\n* `mixed` - Mixed",
"x-spec-enum-id": "943288113dad6782",
"nullable": true
},
"weight": {
"type": "number",
"format": "double",
"maximum": 1000000,
"minimum": -1000000,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true
},
"weight_unit": {
"enum": [
"kg",
"g",
"lb",
"oz",
"",
null
],
"type": "string",
"description": "* `kg` - Kilograms\n* `g` - Grams\n* `lb` - Pounds\n* `oz` - Ounces",
"x-spec-enum-id": "7c1876f422815884",
"nullable": true
},
"front_image": {
"type": "string",
"format": "binary",
"nullable": true
},
"rear_image": {
"type": "string",
"format": "binary",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedWritableDeviceWithConfigContextRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"nullable": true,
"maxLength": 64
},
"device_type": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDeviceTypeRequest"
}
]
},
"role": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDeviceRoleRequest"
}
]
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"platform": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefPlatformRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"serial": {
"type": "string",
"title": "Serial number",
"description": "Chassis serial number, assigned by the manufacturer",
"maxLength": 50
},
"asset_tag": {
"type": "string",
"nullable": true,
"description": "A unique tag used to identify this device",
"maxLength": 50
},
"site": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefSiteRequest"
}
]
},
"location": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefLocationRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"rack": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefRackRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"position": {
"type": "number",
"format": "double",
"maximum": 1000,
"minimum": 0.5,
"exclusiveMaximum": true,
"nullable": true,
"title": "Position (U)"
},
"face": {
"enum": [
"front",
"rear",
"",
null
],
"type": "string",
"description": "* `front` - Front\n* `rear` - Rear",
"x-spec-enum-id": "d2fb9b3f75158b83",
"nullable": true,
"title": "Rack face"
},
"latitude": {
"type": "number",
"format": "double",
"maximum": 100,
"minimum": -100,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true,
"description": "GPS coordinate in decimal format (xx.yyyyyy)"
},
"longitude": {
"type": "number",
"format": "double",
"maximum": 1000,
"minimum": -1000,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true,
"description": "GPS coordinate in decimal format (xx.yyyyyy)"
},
"status": {
"enum": [
"offline",
"active",
"planned",
"staged",
"failed",
"inventory",
"decommissioning"
],
"type": "string",
"description": "* `offline` - Offline\n* `active` - Active\n* `planned` - Planned\n* `staged` - Staged\n* `failed` - Failed\n* `inventory` - Inventory\n* `decommissioning` - Decommissioning",
"x-spec-enum-id": "8d8971779f16ee18"
},
"airflow": {
"enum": [
"front-to-rear",
"rear-to-front",
"left-to-right",
"right-to-left",
"side-to-rear",
"rear-to-side",
"bottom-to-top",
"top-to-bottom",
"passive",
"mixed",
"",
null
],
"type": "string",
"description": "* `front-to-rear` - Front to rear\n* `rear-to-front` - Rear to front\n* `left-to-right` - Left to right\n* `right-to-left` - Right to left\n* `side-to-rear` - Side to rear\n* `rear-to-side` - Rear to side\n* `bottom-to-top` - Bottom to top\n* `top-to-bottom` - Top to bottom\n* `passive` - Passive\n* `mixed` - Mixed",
"x-spec-enum-id": "943288113dad6782",
"nullable": true
},
"primary_ip4": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefIPAddressRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"primary_ip6": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefIPAddressRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"oob_ip": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefIPAddressRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"cluster": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefClusterRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"virtual_chassis": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefVirtualChassisRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"vc_position": {
"type": "integer",
"maximum": 255,
"minimum": 0,
"nullable": true
},
"vc_priority": {
"type": "integer",
"maximum": 255,
"minimum": 0,
"nullable": true,
"description": "Virtual chassis master election priority"
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"config_template": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefConfigTemplateRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"local_context_data": {
"nullable": true,
"description": "Local config context data takes precedence over source contexts in the final rendered config context"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedWritableEventRuleRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"object_types": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 150
},
"enabled": {
"type": "boolean"
},
"event_types": {
"type": "array",
"items": {
"enum": [
"object_created",
"object_updated",
"object_deleted",
"job_started",
"job_completed",
"job_failed",
"job_errored"
],
"type": "string",
"description": "* `object_created` - Object created\n* `object_updated` - Object updated\n* `object_deleted` - Object deleted\n* `job_started` - Job started\n* `job_completed` - Job completed\n* `job_failed` - Job failed\n* `job_errored` - Job errored",
"x-spec-enum-id": "80d172232f4af424"
},
"description": "The types of event which will trigger this rule."
},
"conditions": {
"nullable": true,
"description": "A set of conditions which determine whether the event will be generated."
},
"action_type": {
"enum": [
"webhook",
"script",
"notification"
],
"type": "string",
"description": "* `webhook` - Webhook\n* `script` - Script\n* `notification` - Notification",
"x-spec-enum-id": "d07193c73ebc03c6"
},
"action_object_type": {
"type": "string"
},
"action_object_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
}
}
},
"PatchedWritableFrontPortRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"device": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDeviceRequest"
}
]
},
"module": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"enum": [
"8p8c",
"8p6c",
"8p4c",
"8p2c",
"6p6c",
"6p4c",
"6p2c",
"4p4c",
"4p2c",
"gg45",
"tera-4p",
"tera-2p",
"tera-1p",
"110-punch",
"bnc",
"f",
"n",
"mrj21",
"fc",
"fc-pc",
"fc-upc",
"fc-apc",
"lc",
"lc-pc",
"lc-upc",
"lc-apc",
"lsh",
"lsh-pc",
"lsh-upc",
"lsh-apc",
"lx5",
"lx5-pc",
"lx5-upc",
"lx5-apc",
"mpo",
"mtrj",
"sc",
"sc-pc",
"sc-upc",
"sc-apc",
"st",
"cs",
"sn",
"sma-905",
"sma-906",
"urm-p2",
"urm-p4",
"urm-p8",
"splice",
"usb-a",
"usb-b",
"usb-c",
"usb-mini-a",
"usb-mini-b",
"usb-micro-a",
"usb-micro-b",
"usb-micro-ab",
"other"
],
"type": "string",
"description": "* `8p8c` - 8P8C\n* `8p6c` - 8P6C\n* `8p4c` - 8P4C\n* `8p2c` - 8P2C\n* `6p6c` - 6P6C\n* `6p4c` - 6P4C\n* `6p2c` - 6P2C\n* `4p4c` - 4P4C\n* `4p2c` - 4P2C\n* `gg45` - GG45\n* `tera-4p` - TERA 4P\n* `tera-2p` - TERA 2P\n* `tera-1p` - TERA 1P\n* `110-punch` - 110 Punch\n* `bnc` - BNC\n* `f` - F Connector\n* `n` - N Connector\n* `mrj21` - MRJ21\n* `fc` - FC\n* `fc-pc` - FC/PC\n* `fc-upc` - FC/UPC\n* `fc-apc` - FC/APC\n* `lc` - LC\n* `lc-pc` - LC/PC\n* `lc-upc` - LC/UPC\n* `lc-apc` - LC/APC\n* `lsh` - LSH\n* `lsh-pc` - LSH/PC\n* `lsh-upc` - LSH/UPC\n* `lsh-apc` - LSH/APC\n* `lx5` - LX.5\n* `lx5-pc` - LX.5/PC\n* `lx5-upc` - LX.5/UPC\n* `lx5-apc` - LX.5/APC\n* `mpo` - MPO\n* `mtrj` - MTRJ\n* `sc` - SC\n* `sc-pc` - SC/PC\n* `sc-upc` - SC/UPC\n* `sc-apc` - SC/APC\n* `st` - ST\n* `cs` - CS\n* `sn` - SN\n* `sma-905` - SMA 905\n* `sma-906` - SMA 906\n* `urm-p2` - URM-P2\n* `urm-p4` - URM-P4\n* `urm-p8` - URM-P8\n* `splice` - Splice\n* `usb-a` - USB Type A\n* `usb-b` - USB Type B\n* `usb-c` - USB Type C\n* `usb-mini-a` - USB Mini A\n* `usb-mini-b` - USB Mini B\n* `usb-micro-a` - USB Micro A\n* `usb-micro-b` - USB Micro B\n* `usb-micro-ab` - USB Micro AB\n* `other` - Other",
"x-spec-enum-id": "ea67ae8ba4602f8a"
},
"color": {
"type": "string",
"pattern": "^[0-9a-f]{6}$",
"maxLength": 6
},
"rear_port": {
"type": "integer"
},
"rear_port_position": {
"type": "integer",
"maximum": 1024,
"minimum": 1,
"description": "Mapped position on corresponding rear port"
},
"description": {
"type": "string",
"maxLength": 200
},
"mark_connected": {
"type": "boolean",
"description": "Treat as if a cable is connected"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedWritableFrontPortTemplateRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"device_type": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefDeviceTypeRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"module_type": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleTypeRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"description": "{module} is accepted as a substitution for the module bay position when attached to a module type.",
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"enum": [
"8p8c",
"8p6c",
"8p4c",
"8p2c",
"6p6c",
"6p4c",
"6p2c",
"4p4c",
"4p2c",
"gg45",
"tera-4p",
"tera-2p",
"tera-1p",
"110-punch",
"bnc",
"f",
"n",
"mrj21",
"fc",
"fc-pc",
"fc-upc",
"fc-apc",
"lc",
"lc-pc",
"lc-upc",
"lc-apc",
"lsh",
"lsh-pc",
"lsh-upc",
"lsh-apc",
"lx5",
"lx5-pc",
"lx5-upc",
"lx5-apc",
"mpo",
"mtrj",
"sc",
"sc-pc",
"sc-upc",
"sc-apc",
"st",
"cs",
"sn",
"sma-905",
"sma-906",
"urm-p2",
"urm-p4",
"urm-p8",
"splice",
"usb-a",
"usb-b",
"usb-c",
"usb-mini-a",
"usb-mini-b",
"usb-micro-a",
"usb-micro-b",
"usb-micro-ab",
"other"
],
"type": "string",
"description": "* `8p8c` - 8P8C\n* `8p6c` - 8P6C\n* `8p4c` - 8P4C\n* `8p2c` - 8P2C\n* `6p6c` - 6P6C\n* `6p4c` - 6P4C\n* `6p2c` - 6P2C\n* `4p4c` - 4P4C\n* `4p2c` - 4P2C\n* `gg45` - GG45\n* `tera-4p` - TERA 4P\n* `tera-2p` - TERA 2P\n* `tera-1p` - TERA 1P\n* `110-punch` - 110 Punch\n* `bnc` - BNC\n* `f` - F Connector\n* `n` - N Connector\n* `mrj21` - MRJ21\n* `fc` - FC\n* `fc-pc` - FC/PC\n* `fc-upc` - FC/UPC\n* `fc-apc` - FC/APC\n* `lc` - LC\n* `lc-pc` - LC/PC\n* `lc-upc` - LC/UPC\n* `lc-apc` - LC/APC\n* `lsh` - LSH\n* `lsh-pc` - LSH/PC\n* `lsh-upc` - LSH/UPC\n* `lsh-apc` - LSH/APC\n* `lx5` - LX.5\n* `lx5-pc` - LX.5/PC\n* `lx5-upc` - LX.5/UPC\n* `lx5-apc` - LX.5/APC\n* `mpo` - MPO\n* `mtrj` - MTRJ\n* `sc` - SC\n* `sc-pc` - SC/PC\n* `sc-upc` - SC/UPC\n* `sc-apc` - SC/APC\n* `st` - ST\n* `cs` - CS\n* `sn` - SN\n* `sma-905` - SMA 905\n* `sma-906` - SMA 906\n* `urm-p2` - URM-P2\n* `urm-p4` - URM-P4\n* `urm-p8` - URM-P8\n* `splice` - Splice\n* `usb-a` - USB Type A\n* `usb-b` - USB Type B\n* `usb-c` - USB Type C\n* `usb-mini-a` - USB Mini A\n* `usb-mini-b` - USB Mini B\n* `usb-micro-a` - USB Micro A\n* `usb-micro-b` - USB Micro B\n* `usb-micro-ab` - USB Micro AB\n* `other` - Other",
"x-spec-enum-id": "ea67ae8ba4602f8a"
},
"color": {
"type": "string",
"pattern": "^[0-9a-f]{6}$",
"maxLength": 6
},
"rear_port": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefRearPortTemplateRequest"
}
]
},
"rear_port_position": {
"type": "integer",
"maximum": 1024,
"minimum": 1
},
"description": {
"type": "string",
"maxLength": 200
}
}
},
"PatchedWritableIKEPolicyRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"version": {
"enum": [
1,
2
],
"type": "integer",
"description": "* `1` - IKEv1\n* `2` - IKEv2",
"x-spec-enum-id": "00872b77916a1fde",
"minimum": 0,
"maximum": 32767
},
"mode": {
"enum": [
"aggressive",
"main",
"",
null
],
"type": "string",
"description": "* `aggressive` - Aggressive\n* `main` - Main",
"x-spec-enum-id": "64c1be7bdb2548ca",
"nullable": true
},
"proposals": {
"type": "array",
"items": {
"type": "integer"
}
},
"preshared_key": {
"type": "string",
"title": "Pre-shared key"
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedWritableIKEProposalRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"authentication_method": {
"enum": [
"preshared-keys",
"certificates",
"rsa-signatures",
"dsa-signatures"
],
"type": "string",
"description": "* `preshared-keys` - Pre-shared keys\n* `certificates` - Certificates\n* `rsa-signatures` - RSA signatures\n* `dsa-signatures` - DSA signatures",
"x-spec-enum-id": "92bb2f1103b3a262"
},
"encryption_algorithm": {
"enum": [
"aes-128-cbc",
"aes-128-gcm",
"aes-192-cbc",
"aes-192-gcm",
"aes-256-cbc",
"aes-256-gcm",
"3des-cbc",
"des-cbc"
],
"type": "string",
"description": "* `aes-128-cbc` - 128-bit AES (CBC)\n* `aes-128-gcm` - 128-bit AES (GCM)\n* `aes-192-cbc` - 192-bit AES (CBC)\n* `aes-192-gcm` - 192-bit AES (GCM)\n* `aes-256-cbc` - 256-bit AES (CBC)\n* `aes-256-gcm` - 256-bit AES (GCM)\n* `3des-cbc` - 3DES\n* `des-cbc` - DES",
"x-spec-enum-id": "b022535cfdee79fe"
},
"authentication_algorithm": {
"enum": [
"hmac-sha1",
"hmac-sha256",
"hmac-sha384",
"hmac-sha512",
"hmac-md5",
"",
null
],
"type": "string",
"description": "* `hmac-sha1` - SHA-1 HMAC\n* `hmac-sha256` - SHA-256 HMAC\n* `hmac-sha384` - SHA-384 HMAC\n* `hmac-sha512` - SHA-512 HMAC\n* `hmac-md5` - MD5 HMAC",
"x-spec-enum-id": "0830e8839f5dea4f",
"nullable": true
},
"group": {
"enum": [
1,
2,
5,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34
],
"type": "integer",
"x-spec-enum-id": "dbef43be795462a8",
"description": "Diffie-Hellman group ID\n\n* `1` - Group 1\n* `2` - Group 2\n* `5` - Group 5\n* `14` - Group 14\n* `15` - Group 15\n* `16` - Group 16\n* `17` - Group 17\n* `18` - Group 18\n* `19` - Group 19\n* `20` - Group 20\n* `21` - Group 21\n* `22` - Group 22\n* `23` - Group 23\n* `24` - Group 24\n* `25` - Group 25\n* `26` - Group 26\n* `27` - Group 27\n* `28` - Group 28\n* `29` - Group 29\n* `30` - Group 30\n* `31` - Group 31\n* `32` - Group 32\n* `33` - Group 33\n* `34` - Group 34",
"minimum": 0,
"maximum": 32767
},
"sa_lifetime": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"description": "Security association lifetime (in seconds)"
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedWritableIPAddressRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"address": {
"type": "string",
"minLength": 1
},
"vrf": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefVRFRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"status": {
"enum": [
"active",
"reserved",
"deprecated",
"dhcp",
"slaac"
],
"type": "string",
"x-spec-enum-id": "24935cfee15bd268",
"description": "The operational status of this IP\n\n* `active` - Active\n* `reserved` - Reserved\n* `deprecated` - Deprecated\n* `dhcp` - DHCP\n* `slaac` - SLAAC"
},
"role": {
"enum": [
"loopback",
"secondary",
"anycast",
"vip",
"vrrp",
"hsrp",
"glbp",
"carp",
"",
null
],
"type": "string",
"x-spec-enum-id": "10fbcb4930889b0f",
"nullable": true,
"description": "The functional role of this IP\n\n* `loopback` - Loopback\n* `secondary` - Secondary\n* `anycast` - Anycast\n* `vip` - VIP\n* `vrrp` - VRRP\n* `hsrp` - HSRP\n* `glbp` - GLBP\n* `carp` - CARP"
},
"assigned_object_type": {
"type": "string",
"nullable": true
},
"assigned_object_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64",
"nullable": true
},
"nat_inside": {
"type": "integer",
"nullable": true,
"title": "NAT (inside)",
"description": "The IP for which this address is the \"outside\" IP"
},
"dns_name": {
"type": "string",
"description": "Hostname or FQDN (not case-sensitive)",
"pattern": "^([0-9A-Za-z_-]+|\\*)(\\.[0-9A-Za-z_-]+)*\\.?$",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedWritableIPRangeRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"start_address": {
"type": "string",
"minLength": 1
},
"end_address": {
"type": "string",
"minLength": 1
},
"vrf": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefVRFRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"status": {
"enum": [
"active",
"reserved",
"deprecated"
],
"type": "string",
"x-spec-enum-id": "6388dfb94ca1cc15",
"description": "Operational status of this range\n\n* `active` - Active\n* `reserved` - Reserved\n* `deprecated` - Deprecated"
},
"role": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefRoleRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"mark_populated": {
"type": "boolean",
"description": "Prevent the creation of IP addresses within this range"
},
"mark_utilized": {
"type": "boolean",
"description": "Report space as 100% utilized"
}
}
},
"PatchedWritableIPSecPolicyRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"proposals": {
"type": "array",
"items": {
"type": "integer"
}
},
"pfs_group": {
"enum": [
1,
2,
5,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34,
null
],
"type": "integer",
"x-spec-enum-id": "dbef43be795462a8",
"nullable": true,
"description": "Diffie-Hellman group for Perfect Forward Secrecy\n\n* `1` - Group 1\n* `2` - Group 2\n* `5` - Group 5\n* `14` - Group 14\n* `15` - Group 15\n* `16` - Group 16\n* `17` - Group 17\n* `18` - Group 18\n* `19` - Group 19\n* `20` - Group 20\n* `21` - Group 21\n* `22` - Group 22\n* `23` - Group 23\n* `24` - Group 24\n* `25` - Group 25\n* `26` - Group 26\n* `27` - Group 27\n* `28` - Group 28\n* `29` - Group 29\n* `30` - Group 30\n* `31` - Group 31\n* `32` - Group 32\n* `33` - Group 33\n* `34` - Group 34",
"minimum": 0,
"maximum": 32767
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedWritableIPSecProfileRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"mode": {
"enum": [
"esp",
"ah"
],
"type": "string",
"description": "* `esp` - ESP\n* `ah` - AH",
"x-spec-enum-id": "1136c2cdfee84436"
},
"ike_policy": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefIKEPolicyRequest"
}
]
},
"ipsec_policy": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefIPSecPolicyRequest"
}
]
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedWritableIPSecProposalRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"encryption_algorithm": {
"enum": [
"aes-128-cbc",
"aes-128-gcm",
"aes-192-cbc",
"aes-192-gcm",
"aes-256-cbc",
"aes-256-gcm",
"3des-cbc",
"des-cbc",
"",
null
],
"type": "string",
"description": "* `aes-128-cbc` - 128-bit AES (CBC)\n* `aes-128-gcm` - 128-bit AES (GCM)\n* `aes-192-cbc` - 192-bit AES (CBC)\n* `aes-192-gcm` - 192-bit AES (GCM)\n* `aes-256-cbc` - 256-bit AES (CBC)\n* `aes-256-gcm` - 256-bit AES (GCM)\n* `3des-cbc` - 3DES\n* `des-cbc` - DES",
"x-spec-enum-id": "b022535cfdee79fe",
"nullable": true,
"title": "Encryption"
},
"authentication_algorithm": {
"enum": [
"hmac-sha1",
"hmac-sha256",
"hmac-sha384",
"hmac-sha512",
"hmac-md5",
"",
null
],
"type": "string",
"description": "* `hmac-sha1` - SHA-1 HMAC\n* `hmac-sha256` - SHA-256 HMAC\n* `hmac-sha384` - SHA-384 HMAC\n* `hmac-sha512` - SHA-512 HMAC\n* `hmac-md5` - MD5 HMAC",
"x-spec-enum-id": "0830e8839f5dea4f",
"nullable": true,
"title": "Authentication"
},
"sa_lifetime_seconds": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"title": "SA lifetime (seconds)",
"description": "Security association lifetime (seconds)"
},
"sa_lifetime_data": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"title": "SA lifetime (KB)",
"description": "Security association lifetime (in kilobytes)"
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedWritableInterfaceRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"device": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDeviceRequest"
}
]
},
"vdcs": {
"type": "array",
"items": {
"type": "integer"
}
},
"module": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"enum": [
"virtual",
"bridge",
"lag",
"100base-fx",
"100base-lfx",
"100base-tx",
"100base-t1",
"1000base-t",
"1000base-sx",
"1000base-lx",
"1000base-tx",
"2.5gbase-t",
"5gbase-t",
"10gbase-t",
"10gbase-cx4",
"100base-x-sfp",
"1000base-x-gbic",
"1000base-x-sfp",
"10gbase-x-sfpp",
"10gbase-x-xfp",
"10gbase-x-xenpak",
"10gbase-x-x2",
"25gbase-x-sfp28",
"50gbase-x-sfp56",
"40gbase-x-qsfpp",
"50gbase-x-sfp28",
"100gbase-x-cfp",
"100gbase-x-cfp2",
"200gbase-x-cfp2",
"400gbase-x-cfp2",
"100gbase-x-cfp4",
"100gbase-x-cxp",
"100gbase-x-cpak",
"100gbase-x-dsfp",
"100gbase-x-sfpdd",
"100gbase-x-qsfp28",
"100gbase-x-qsfpdd",
"200gbase-x-qsfp56",
"200gbase-x-qsfpdd",
"400gbase-x-qsfp112",
"400gbase-x-qsfpdd",
"400gbase-x-osfp",
"400gbase-x-osfp-rhs",
"400gbase-x-cdfp",
"400gbase-x-cfp8",
"800gbase-x-qsfpdd",
"800gbase-x-osfp",
"1000base-kx",
"2.5gbase-kx",
"5gbase-kr",
"10gbase-kr",
"10gbase-kx4",
"25gbase-kr",
"40gbase-kr4",
"50gbase-kr",
"100gbase-kp4",
"100gbase-kr2",
"100gbase-kr4",
"ieee802.11a",
"ieee802.11g",
"ieee802.11n",
"ieee802.11ac",
"ieee802.11ad",
"ieee802.11ax",
"ieee802.11ay",
"ieee802.11be",
"ieee802.15.1",
"ieee802.15.4",
"other-wireless",
"gsm",
"cdma",
"lte",
"4g",
"5g",
"sonet-oc3",
"sonet-oc12",
"sonet-oc48",
"sonet-oc192",
"sonet-oc768",
"sonet-oc1920",
"sonet-oc3840",
"1gfc-sfp",
"2gfc-sfp",
"4gfc-sfp",
"8gfc-sfpp",
"16gfc-sfpp",
"32gfc-sfp28",
"32gfc-sfpp",
"64gfc-qsfpp",
"64gfc-sfpdd",
"64gfc-sfpp",
"128gfc-qsfp28",
"infiniband-sdr",
"infiniband-ddr",
"infiniband-qdr",
"infiniband-fdr10",
"infiniband-fdr",
"infiniband-edr",
"infiniband-hdr",
"infiniband-ndr",
"infiniband-xdr",
"t1",
"e1",
"t3",
"e3",
"xdsl",
"docsis",
"moca",
"bpon",
"epon",
"10g-epon",
"gpon",
"xg-pon",
"xgs-pon",
"ng-pon2",
"25g-pon",
"50g-pon",
"cisco-stackwise",
"cisco-stackwise-plus",
"cisco-flexstack",
"cisco-flexstack-plus",
"cisco-stackwise-80",
"cisco-stackwise-160",
"cisco-stackwise-320",
"cisco-stackwise-480",
"cisco-stackwise-1t",
"juniper-vcp",
"extreme-summitstack",
"extreme-summitstack-128",
"extreme-summitstack-256",
"extreme-summitstack-512",
"other"
],
"type": "string",
"description": "* `virtual` - Virtual\n* `bridge` - Bridge\n* `lag` - Link Aggregation Group (LAG)\n* `100base-fx` - 100BASE-FX (10/100ME FIBER)\n* `100base-lfx` - 100BASE-LFX (10/100ME FIBER)\n* `100base-tx` - 100BASE-TX (10/100ME)\n* `100base-t1` - 100BASE-T1 (10/100ME Single Pair)\n* `1000base-t` - 1000BASE-T (1GE)\n* `1000base-sx` - 1000BASE-SX (1GE)\n* `1000base-lx` - 1000BASE-LX (1GE)\n* `1000base-tx` - 1000BASE-TX (1GE)\n* `2.5gbase-t` - 2.5GBASE-T (2.5GE)\n* `5gbase-t` - 5GBASE-T (5GE)\n* `10gbase-t` - 10GBASE-T (10GE)\n* `10gbase-cx4` - 10GBASE-CX4 (10GE)\n* `100base-x-sfp` - SFP (100ME)\n* `1000base-x-gbic` - GBIC (1GE)\n* `1000base-x-sfp` - SFP (1GE)\n* `10gbase-x-sfpp` - SFP+ (10GE)\n* `10gbase-x-xfp` - XFP (10GE)\n* `10gbase-x-xenpak` - XENPAK (10GE)\n* `10gbase-x-x2` - X2 (10GE)\n* `25gbase-x-sfp28` - SFP28 (25GE)\n* `50gbase-x-sfp56` - SFP56 (50GE)\n* `40gbase-x-qsfpp` - QSFP+ (40GE)\n* `50gbase-x-sfp28` - QSFP28 (50GE)\n* `100gbase-x-cfp` - CFP (100GE)\n* `100gbase-x-cfp2` - CFP2 (100GE)\n* `200gbase-x-cfp2` - CFP2 (200GE)\n* `400gbase-x-cfp2` - CFP2 (400GE)\n* `100gbase-x-cfp4` - CFP4 (100GE)\n* `100gbase-x-cxp` - CXP (100GE)\n* `100gbase-x-cpak` - Cisco CPAK (100GE)\n* `100gbase-x-dsfp` - DSFP (100GE)\n* `100gbase-x-sfpdd` - SFP-DD (100GE)\n* `100gbase-x-qsfp28` - QSFP28 (100GE)\n* `100gbase-x-qsfpdd` - QSFP-DD (100GE)\n* `200gbase-x-qsfp56` - QSFP56 (200GE)\n* `200gbase-x-qsfpdd` - QSFP-DD (200GE)\n* `400gbase-x-qsfp112` - QSFP112 (400GE)\n* `400gbase-x-qsfpdd` - QSFP-DD (400GE)\n* `400gbase-x-osfp` - OSFP (400GE)\n* `400gbase-x-osfp-rhs` - OSFP-RHS (400GE)\n* `400gbase-x-cdfp` - CDFP (400GE)\n* `400gbase-x-cfp8` - CPF8 (400GE)\n* `800gbase-x-qsfpdd` - QSFP-DD (800GE)\n* `800gbase-x-osfp` - OSFP (800GE)\n* `1000base-kx` - 1000BASE-KX (1GE)\n* `2.5gbase-kx` - 2.5GBASE-KX (2.5GE)\n* `5gbase-kr` - 5GBASE-KR (5GE)\n* `10gbase-kr` - 10GBASE-KR (10GE)\n* `10gbase-kx4` - 10GBASE-KX4 (10GE)\n* `25gbase-kr` - 25GBASE-KR (25GE)\n* `40gbase-kr4` - 40GBASE-KR4 (40GE)\n* `50gbase-kr` - 50GBASE-KR (50GE)\n* `100gbase-kp4` - 100GBASE-KP4 (100GE)\n* `100gbase-kr2` - 100GBASE-KR2 (100GE)\n* `100gbase-kr4` - 100GBASE-KR4 (100GE)\n* `ieee802.11a` - IEEE 802.11a\n* `ieee802.11g` - IEEE 802.11b/g\n* `ieee802.11n` - IEEE 802.11n\n* `ieee802.11ac` - IEEE 802.11ac\n* `ieee802.11ad` - IEEE 802.11ad\n* `ieee802.11ax` - IEEE 802.11ax\n* `ieee802.11ay` - IEEE 802.11ay\n* `ieee802.11be` - IEEE 802.11be\n* `ieee802.15.1` - IEEE 802.15.1 (Bluetooth)\n* `ieee802.15.4` - IEEE 802.15.4 (LR-WPAN)\n* `other-wireless` - Other (Wireless)\n* `gsm` - GSM\n* `cdma` - CDMA\n* `lte` - LTE\n* `4g` - 4G\n* `5g` - 5G\n* `sonet-oc3` - OC-3/STM-1\n* `sonet-oc12` - OC-12/STM-4\n* `sonet-oc48` - OC-48/STM-16\n* `sonet-oc192` - OC-192/STM-64\n* `sonet-oc768` - OC-768/STM-256\n* `sonet-oc1920` - OC-1920/STM-640\n* `sonet-oc3840` - OC-3840/STM-1234\n* `1gfc-sfp` - SFP (1GFC)\n* `2gfc-sfp` - SFP (2GFC)\n* `4gfc-sfp` - SFP (4GFC)\n* `8gfc-sfpp` - SFP+ (8GFC)\n* `16gfc-sfpp` - SFP+ (16GFC)\n* `32gfc-sfp28` - SFP28 (32GFC)\n* `32gfc-sfpp` - SFP+ (32GFC)\n* `64gfc-qsfpp` - QSFP+ (64GFC)\n* `64gfc-sfpdd` - SFP-DD (64GFC)\n* `64gfc-sfpp` - SFP+ (64GFC)\n* `128gfc-qsfp28` - QSFP28 (128GFC)\n* `infiniband-sdr` - SDR (2 Gbps)\n* `infiniband-ddr` - DDR (4 Gbps)\n* `infiniband-qdr` - QDR (8 Gbps)\n* `infiniband-fdr10` - FDR10 (10 Gbps)\n* `infiniband-fdr` - FDR (13.5 Gbps)\n* `infiniband-edr` - EDR (25 Gbps)\n* `infiniband-hdr` - HDR (50 Gbps)\n* `infiniband-ndr` - NDR (100 Gbps)\n* `infiniband-xdr` - XDR (250 Gbps)\n* `t1` - T1 (1.544 Mbps)\n* `e1` - E1 (2.048 Mbps)\n* `t3` - T3 (45 Mbps)\n* `e3` - E3 (34 Mbps)\n* `xdsl` - xDSL\n* `docsis` - DOCSIS\n* `moca` - MoCA\n* `bpon` - BPON (622 Mbps / 155 Mbps)\n* `epon` - EPON (1 Gbps)\n* `10g-epon` - 10G-EPON (10 Gbps)\n* `gpon` - GPON (2.5 Gbps / 1.25 Gbps)\n* `xg-pon` - XG-PON (10 Gbps / 2.5 Gbps)\n* `xgs-pon` - XGS-PON (10 Gbps)\n* `ng-pon2` - NG-PON2 (TWDM-PON) (4x10 Gbps)\n* `25g-pon` - 25G-PON (25 Gbps)\n* `50g-pon` - 50G-PON (50 Gbps)\n* `cisco-stackwise` - Cisco StackWise\n* `cisco-stackwise-plus` - Cisco StackWise Plus\n* `cisco-flexstack` - Cisco FlexStack\n* `cisco-flexstack-plus` - Cisco FlexStack Plus\n* `cisco-stackwise-80` - Cisco StackWise-80\n* `cisco-stackwise-160` - Cisco StackWise-160\n* `cisco-stackwise-320` - Cisco StackWise-320\n* `cisco-stackwise-480` - Cisco StackWise-480\n* `cisco-stackwise-1t` - Cisco StackWise-1T\n* `juniper-vcp` - Juniper VCP\n* `extreme-summitstack` - Extreme SummitStack\n* `extreme-summitstack-128` - Extreme SummitStack-128\n* `extreme-summitstack-256` - Extreme SummitStack-256\n* `extreme-summitstack-512` - Extreme SummitStack-512\n* `other` - Other",
"x-spec-enum-id": "8c4c5e112f77a383"
},
"enabled": {
"type": "boolean"
},
"parent": {
"type": "integer",
"nullable": true,
"title": "Parent interface"
},
"bridge": {
"type": "integer",
"nullable": true,
"title": "Bridge interface"
},
"lag": {
"type": "integer",
"nullable": true,
"title": "Parent LAG"
},
"mtu": {
"type": "integer",
"maximum": 65536,
"minimum": 1,
"nullable": true
},
"primary_mac_address": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefMACAddressRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"speed": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"title": "Speed (Kbps)"
},
"duplex": {
"enum": [
"half",
"full",
"auto",
"",
null
],
"type": "string",
"description": "* `half` - Half\n* `full` - Full\n* `auto` - Auto",
"x-spec-enum-id": "47eab9b1a65a1e21",
"nullable": true
},
"wwn": {
"type": "string",
"nullable": true
},
"mgmt_only": {
"type": "boolean",
"title": "Management only",
"description": "This interface is used only for out-of-band management"
},
"description": {
"type": "string",
"maxLength": 200
},
"mode": {
"enum": [
"access",
"tagged",
"tagged-all",
"q-in-q",
"",
null
],
"type": "string",
"x-spec-enum-id": "b6fe48fe21dbf01d",
"nullable": true,
"description": "IEEE 802.1Q tagging strategy\n\n* `access` - Access\n* `tagged` - Tagged\n* `tagged-all` - Tagged (All)\n* `q-in-q` - Q-in-Q (802.1ad)"
},
"rf_role": {
"enum": [
"ap",
"station",
"",
null
],
"type": "string",
"description": "* `ap` - Access point\n* `station` - Station",
"x-spec-enum-id": "d2772dbea88b0fb1",
"nullable": true,
"title": "Wireless role"
},
"rf_channel": {
"enum": [
"2.4g-1-2412-22",
"2.4g-2-2417-22",
"2.4g-3-2422-22",
"2.4g-4-2427-22",
"2.4g-5-2432-22",
"2.4g-6-2437-22",
"2.4g-7-2442-22",
"2.4g-8-2447-22",
"2.4g-9-2452-22",
"2.4g-10-2457-22",
"2.4g-11-2462-22",
"2.4g-12-2467-22",
"2.4g-13-2472-22",
"5g-32-5160-20",
"5g-34-5170-40",
"5g-36-5180-20",
"5g-38-5190-40",
"5g-40-5200-20",
"5g-42-5210-80",
"5g-44-5220-20",
"5g-46-5230-40",
"5g-48-5240-20",
"5g-50-5250-160",
"5g-52-5260-20",
"5g-54-5270-40",
"5g-56-5280-20",
"5g-58-5290-80",
"5g-60-5300-20",
"5g-62-5310-40",
"5g-64-5320-20",
"5g-100-5500-20",
"5g-102-5510-40",
"5g-104-5520-20",
"5g-106-5530-80",
"5g-108-5540-20",
"5g-110-5550-40",
"5g-112-5560-20",
"5g-114-5570-160",
"5g-116-5580-20",
"5g-118-5590-40",
"5g-120-5600-20",
"5g-122-5610-80",
"5g-124-5620-20",
"5g-126-5630-40",
"5g-128-5640-20",
"5g-132-5660-20",
"5g-134-5670-40",
"5g-136-5680-20",
"5g-138-5690-80",
"5g-140-5700-20",
"5g-142-5710-40",
"5g-144-5720-20",
"5g-149-5745-20",
"5g-151-5755-40",
"5g-153-5765-20",
"5g-155-5775-80",
"5g-157-5785-20",
"5g-159-5795-40",
"5g-161-5805-20",
"5g-163-5815-160",
"5g-165-5825-20",
"5g-167-5835-40",
"5g-169-5845-20",
"5g-171-5855-80",
"5g-173-5865-20",
"5g-175-5875-40",
"5g-177-5885-20",
"6g-1-5955-20",
"6g-3-5965-40",
"6g-5-5975-20",
"6g-7-5985-80",
"6g-9-5995-20",
"6g-11-6005-40",
"6g-13-6015-20",
"6g-15-6025-160",
"6g-17-6035-20",
"6g-19-6045-40",
"6g-21-6055-20",
"6g-23-6065-80",
"6g-25-6075-20",
"6g-27-6085-40",
"6g-29-6095-20",
"6g-31-6105-320",
"6g-33-6115-20",
"6g-35-6125-40",
"6g-37-6135-20",
"6g-39-6145-80",
"6g-41-6155-20",
"6g-43-6165-40",
"6g-45-6175-20",
"6g-47-6185-160",
"6g-49-6195-20",
"6g-51-6205-40",
"6g-53-6215-20",
"6g-55-6225-80",
"6g-57-6235-20",
"6g-59-6245-40",
"6g-61-6255-20",
"6g-65-6275-20",
"6g-67-6285-40",
"6g-69-6295-20",
"6g-71-6305-80",
"6g-73-6315-20",
"6g-75-6325-40",
"6g-77-6335-20",
"6g-79-6345-160",
"6g-81-6355-20",
"6g-83-6365-40",
"6g-85-6375-20",
"6g-87-6385-80",
"6g-89-6395-20",
"6g-91-6405-40",
"6g-93-6415-20",
"6g-95-6425-320",
"6g-97-6435-20",
"6g-99-6445-40",
"6g-101-6455-20",
"6g-103-6465-80",
"6g-105-6475-20",
"6g-107-6485-40",
"6g-109-6495-20",
"6g-111-6505-160",
"6g-113-6515-20",
"6g-115-6525-40",
"6g-117-6535-20",
"6g-119-6545-80",
"6g-121-6555-20",
"6g-123-6565-40",
"6g-125-6575-20",
"6g-129-6595-20",
"6g-131-6605-40",
"6g-133-6615-20",
"6g-135-6625-80",
"6g-137-6635-20",
"6g-139-6645-40",
"6g-141-6655-20",
"6g-143-6665-160",
"6g-145-6675-20",
"6g-147-6685-40",
"6g-149-6695-20",
"6g-151-6705-80",
"6g-153-6715-20",
"6g-155-6725-40",
"6g-157-6735-20",
"6g-159-6745-320",
"6g-161-6755-20",
"6g-163-6765-40",
"6g-165-6775-20",
"6g-167-6785-80",
"6g-169-6795-20",
"6g-171-6805-40",
"6g-173-6815-20",
"6g-175-6825-160",
"6g-177-6835-20",
"6g-179-6845-40",
"6g-181-6855-20",
"6g-183-6865-80",
"6g-185-6875-20",
"6g-187-6885-40",
"6g-189-6895-20",
"6g-193-6915-20",
"6g-195-6925-40",
"6g-197-6935-20",
"6g-199-6945-80",
"6g-201-6955-20",
"6g-203-6965-40",
"6g-205-6975-20",
"6g-207-6985-160",
"6g-209-6995-20",
"6g-211-7005-40",
"6g-213-7015-20",
"6g-215-7025-80",
"6g-217-7035-20",
"6g-219-7045-40",
"6g-221-7055-20",
"6g-225-7075-20",
"6g-227-7085-40",
"6g-229-7095-20",
"6g-233-7115-20",
"60g-1-58320-2160",
"60g-2-60480-2160",
"60g-3-62640-2160",
"60g-4-64800-2160",
"60g-5-66960-2160",
"60g-6-69120-2160",
"60g-9-59400-4320",
"60g-10-61560-4320",
"60g-11-63720-4320",
"60g-12-65880-4320",
"60g-13-68040-4320",
"60g-17-60480-6480",
"60g-18-62640-6480",
"60g-19-64800-6480",
"60g-20-66960-6480",
"60g-25-61560-6480",
"60g-26-63720-6480",
"60g-27-65880-6480",
"",
null
],
"type": "string",
"description": "* `2.4g-1-2412-22` - 1 (2412 MHz)\n* `2.4g-2-2417-22` - 2 (2417 MHz)\n* `2.4g-3-2422-22` - 3 (2422 MHz)\n* `2.4g-4-2427-22` - 4 (2427 MHz)\n* `2.4g-5-2432-22` - 5 (2432 MHz)\n* `2.4g-6-2437-22` - 6 (2437 MHz)\n* `2.4g-7-2442-22` - 7 (2442 MHz)\n* `2.4g-8-2447-22` - 8 (2447 MHz)\n* `2.4g-9-2452-22` - 9 (2452 MHz)\n* `2.4g-10-2457-22` - 10 (2457 MHz)\n* `2.4g-11-2462-22` - 11 (2462 MHz)\n* `2.4g-12-2467-22` - 12 (2467 MHz)\n* `2.4g-13-2472-22` - 13 (2472 MHz)\n* `5g-32-5160-20` - 32 (5160/20 MHz)\n* `5g-34-5170-40` - 34 (5170/40 MHz)\n* `5g-36-5180-20` - 36 (5180/20 MHz)\n* `5g-38-5190-40` - 38 (5190/40 MHz)\n* `5g-40-5200-20` - 40 (5200/20 MHz)\n* `5g-42-5210-80` - 42 (5210/80 MHz)\n* `5g-44-5220-20` - 44 (5220/20 MHz)\n* `5g-46-5230-40` - 46 (5230/40 MHz)\n* `5g-48-5240-20` - 48 (5240/20 MHz)\n* `5g-50-5250-160` - 50 (5250/160 MHz)\n* `5g-52-5260-20` - 52 (5260/20 MHz)\n* `5g-54-5270-40` - 54 (5270/40 MHz)\n* `5g-56-5280-20` - 56 (5280/20 MHz)\n* `5g-58-5290-80` - 58 (5290/80 MHz)\n* `5g-60-5300-20` - 60 (5300/20 MHz)\n* `5g-62-5310-40` - 62 (5310/40 MHz)\n* `5g-64-5320-20` - 64 (5320/20 MHz)\n* `5g-100-5500-20` - 100 (5500/20 MHz)\n* `5g-102-5510-40` - 102 (5510/40 MHz)\n* `5g-104-5520-20` - 104 (5520/20 MHz)\n* `5g-106-5530-80` - 106 (5530/80 MHz)\n* `5g-108-5540-20` - 108 (5540/20 MHz)\n* `5g-110-5550-40` - 110 (5550/40 MHz)\n* `5g-112-5560-20` - 112 (5560/20 MHz)\n* `5g-114-5570-160` - 114 (5570/160 MHz)\n* `5g-116-5580-20` - 116 (5580/20 MHz)\n* `5g-118-5590-40` - 118 (5590/40 MHz)\n* `5g-120-5600-20` - 120 (5600/20 MHz)\n* `5g-122-5610-80` - 122 (5610/80 MHz)\n* `5g-124-5620-20` - 124 (5620/20 MHz)\n* `5g-126-5630-40` - 126 (5630/40 MHz)\n* `5g-128-5640-20` - 128 (5640/20 MHz)\n* `5g-132-5660-20` - 132 (5660/20 MHz)\n* `5g-134-5670-40` - 134 (5670/40 MHz)\n* `5g-136-5680-20` - 136 (5680/20 MHz)\n* `5g-138-5690-80` - 138 (5690/80 MHz)\n* `5g-140-5700-20` - 140 (5700/20 MHz)\n* `5g-142-5710-40` - 142 (5710/40 MHz)\n* `5g-144-5720-20` - 144 (5720/20 MHz)\n* `5g-149-5745-20` - 149 (5745/20 MHz)\n* `5g-151-5755-40` - 151 (5755/40 MHz)\n* `5g-153-5765-20` - 153 (5765/20 MHz)\n* `5g-155-5775-80` - 155 (5775/80 MHz)\n* `5g-157-5785-20` - 157 (5785/20 MHz)\n* `5g-159-5795-40` - 159 (5795/40 MHz)\n* `5g-161-5805-20` - 161 (5805/20 MHz)\n* `5g-163-5815-160` - 163 (5815/160 MHz)\n* `5g-165-5825-20` - 165 (5825/20 MHz)\n* `5g-167-5835-40` - 167 (5835/40 MHz)\n* `5g-169-5845-20` - 169 (5845/20 MHz)\n* `5g-171-5855-80` - 171 (5855/80 MHz)\n* `5g-173-5865-20` - 173 (5865/20 MHz)\n* `5g-175-5875-40` - 175 (5875/40 MHz)\n* `5g-177-5885-20` - 177 (5885/20 MHz)\n* `6g-1-5955-20` - 1 (5955/20 MHz)\n* `6g-3-5965-40` - 3 (5965/40 MHz)\n* `6g-5-5975-20` - 5 (5975/20 MHz)\n* `6g-7-5985-80` - 7 (5985/80 MHz)\n* `6g-9-5995-20` - 9 (5995/20 MHz)\n* `6g-11-6005-40` - 11 (6005/40 MHz)\n* `6g-13-6015-20` - 13 (6015/20 MHz)\n* `6g-15-6025-160` - 15 (6025/160 MHz)\n* `6g-17-6035-20` - 17 (6035/20 MHz)\n* `6g-19-6045-40` - 19 (6045/40 MHz)\n* `6g-21-6055-20` - 21 (6055/20 MHz)\n* `6g-23-6065-80` - 23 (6065/80 MHz)\n* `6g-25-6075-20` - 25 (6075/20 MHz)\n* `6g-27-6085-40` - 27 (6085/40 MHz)\n* `6g-29-6095-20` - 29 (6095/20 MHz)\n* `6g-31-6105-320` - 31 (6105/320 MHz)\n* `6g-33-6115-20` - 33 (6115/20 MHz)\n* `6g-35-6125-40` - 35 (6125/40 MHz)\n* `6g-37-6135-20` - 37 (6135/20 MHz)\n* `6g-39-6145-80` - 39 (6145/80 MHz)\n* `6g-41-6155-20` - 41 (6155/20 MHz)\n* `6g-43-6165-40` - 43 (6165/40 MHz)\n* `6g-45-6175-20` - 45 (6175/20 MHz)\n* `6g-47-6185-160` - 47 (6185/160 MHz)\n* `6g-49-6195-20` - 49 (6195/20 MHz)\n* `6g-51-6205-40` - 51 (6205/40 MHz)\n* `6g-53-6215-20` - 53 (6215/20 MHz)\n* `6g-55-6225-80` - 55 (6225/80 MHz)\n* `6g-57-6235-20` - 57 (6235/20 MHz)\n* `6g-59-6245-40` - 59 (6245/40 MHz)\n* `6g-61-6255-20` - 61 (6255/20 MHz)\n* `6g-65-6275-20` - 65 (6275/20 MHz)\n* `6g-67-6285-40` - 67 (6285/40 MHz)\n* `6g-69-6295-20` - 69 (6295/20 MHz)\n* `6g-71-6305-80` - 71 (6305/80 MHz)\n* `6g-73-6315-20` - 73 (6315/20 MHz)\n* `6g-75-6325-40` - 75 (6325/40 MHz)\n* `6g-77-6335-20` - 77 (6335/20 MHz)\n* `6g-79-6345-160` - 79 (6345/160 MHz)\n* `6g-81-6355-20` - 81 (6355/20 MHz)\n* `6g-83-6365-40` - 83 (6365/40 MHz)\n* `6g-85-6375-20` - 85 (6375/20 MHz)\n* `6g-87-6385-80` - 87 (6385/80 MHz)\n* `6g-89-6395-20` - 89 (6395/20 MHz)\n* `6g-91-6405-40` - 91 (6405/40 MHz)\n* `6g-93-6415-20` - 93 (6415/20 MHz)\n* `6g-95-6425-320` - 95 (6425/320 MHz)\n* `6g-97-6435-20` - 97 (6435/20 MHz)\n* `6g-99-6445-40` - 99 (6445/40 MHz)\n* `6g-101-6455-20` - 101 (6455/20 MHz)\n* `6g-103-6465-80` - 103 (6465/80 MHz)\n* `6g-105-6475-20` - 105 (6475/20 MHz)\n* `6g-107-6485-40` - 107 (6485/40 MHz)\n* `6g-109-6495-20` - 109 (6495/20 MHz)\n* `6g-111-6505-160` - 111 (6505/160 MHz)\n* `6g-113-6515-20` - 113 (6515/20 MHz)\n* `6g-115-6525-40` - 115 (6525/40 MHz)\n* `6g-117-6535-20` - 117 (6535/20 MHz)\n* `6g-119-6545-80` - 119 (6545/80 MHz)\n* `6g-121-6555-20` - 121 (6555/20 MHz)\n* `6g-123-6565-40` - 123 (6565/40 MHz)\n* `6g-125-6575-20` - 125 (6575/20 MHz)\n* `6g-129-6595-20` - 129 (6595/20 MHz)\n* `6g-131-6605-40` - 131 (6605/40 MHz)\n* `6g-133-6615-20` - 133 (6615/20 MHz)\n* `6g-135-6625-80` - 135 (6625/80 MHz)\n* `6g-137-6635-20` - 137 (6635/20 MHz)\n* `6g-139-6645-40` - 139 (6645/40 MHz)\n* `6g-141-6655-20` - 141 (6655/20 MHz)\n* `6g-143-6665-160` - 143 (6665/160 MHz)\n* `6g-145-6675-20` - 145 (6675/20 MHz)\n* `6g-147-6685-40` - 147 (6685/40 MHz)\n* `6g-149-6695-20` - 149 (6695/20 MHz)\n* `6g-151-6705-80` - 151 (6705/80 MHz)\n* `6g-153-6715-20` - 153 (6715/20 MHz)\n* `6g-155-6725-40` - 155 (6725/40 MHz)\n* `6g-157-6735-20` - 157 (6735/20 MHz)\n* `6g-159-6745-320` - 159 (6745/320 MHz)\n* `6g-161-6755-20` - 161 (6755/20 MHz)\n* `6g-163-6765-40` - 163 (6765/40 MHz)\n* `6g-165-6775-20` - 165 (6775/20 MHz)\n* `6g-167-6785-80` - 167 (6785/80 MHz)\n* `6g-169-6795-20` - 169 (6795/20 MHz)\n* `6g-171-6805-40` - 171 (6805/40 MHz)\n* `6g-173-6815-20` - 173 (6815/20 MHz)\n* `6g-175-6825-160` - 175 (6825/160 MHz)\n* `6g-177-6835-20` - 177 (6835/20 MHz)\n* `6g-179-6845-40` - 179 (6845/40 MHz)\n* `6g-181-6855-20` - 181 (6855/20 MHz)\n* `6g-183-6865-80` - 183 (6865/80 MHz)\n* `6g-185-6875-20` - 185 (6875/20 MHz)\n* `6g-187-6885-40` - 187 (6885/40 MHz)\n* `6g-189-6895-20` - 189 (6895/20 MHz)\n* `6g-193-6915-20` - 193 (6915/20 MHz)\n* `6g-195-6925-40` - 195 (6925/40 MHz)\n* `6g-197-6935-20` - 197 (6935/20 MHz)\n* `6g-199-6945-80` - 199 (6945/80 MHz)\n* `6g-201-6955-20` - 201 (6955/20 MHz)\n* `6g-203-6965-40` - 203 (6965/40 MHz)\n* `6g-205-6975-20` - 205 (6975/20 MHz)\n* `6g-207-6985-160` - 207 (6985/160 MHz)\n* `6g-209-6995-20` - 209 (6995/20 MHz)\n* `6g-211-7005-40` - 211 (7005/40 MHz)\n* `6g-213-7015-20` - 213 (7015/20 MHz)\n* `6g-215-7025-80` - 215 (7025/80 MHz)\n* `6g-217-7035-20` - 217 (7035/20 MHz)\n* `6g-219-7045-40` - 219 (7045/40 MHz)\n* `6g-221-7055-20` - 221 (7055/20 MHz)\n* `6g-225-7075-20` - 225 (7075/20 MHz)\n* `6g-227-7085-40` - 227 (7085/40 MHz)\n* `6g-229-7095-20` - 229 (7095/20 MHz)\n* `6g-233-7115-20` - 233 (7115/20 MHz)\n* `60g-1-58320-2160` - 1 (58.32/2.16 GHz)\n* `60g-2-60480-2160` - 2 (60.48/2.16 GHz)\n* `60g-3-62640-2160` - 3 (62.64/2.16 GHz)\n* `60g-4-64800-2160` - 4 (64.80/2.16 GHz)\n* `60g-5-66960-2160` - 5 (66.96/2.16 GHz)\n* `60g-6-69120-2160` - 6 (69.12/2.16 GHz)\n* `60g-9-59400-4320` - 9 (59.40/4.32 GHz)\n* `60g-10-61560-4320` - 10 (61.56/4.32 GHz)\n* `60g-11-63720-4320` - 11 (63.72/4.32 GHz)\n* `60g-12-65880-4320` - 12 (65.88/4.32 GHz)\n* `60g-13-68040-4320` - 13 (68.04/4.32 GHz)\n* `60g-17-60480-6480` - 17 (60.48/6.48 GHz)\n* `60g-18-62640-6480` - 18 (62.64/6.48 GHz)\n* `60g-19-64800-6480` - 19 (64.80/6.48 GHz)\n* `60g-20-66960-6480` - 20 (66.96/6.48 GHz)\n* `60g-25-61560-6480` - 25 (61.56/8.64 GHz)\n* `60g-26-63720-6480` - 26 (63.72/8.64 GHz)\n* `60g-27-65880-6480` - 27 (65.88/8.64 GHz)",
"x-spec-enum-id": "aac33cc237adc8f9",
"nullable": true,
"title": "Wireless channel"
},
"poe_mode": {
"enum": [
"pd",
"pse",
"",
null
],
"type": "string",
"description": "* `pd` - PD\n* `pse` - PSE",
"x-spec-enum-id": "2f2fe6dcdc7772bd",
"nullable": true
},
"poe_type": {
"enum": [
"type1-ieee802.3af",
"type2-ieee802.3at",
"type3-ieee802.3bt",
"type4-ieee802.3bt",
"passive-24v-2pair",
"passive-24v-4pair",
"passive-48v-2pair",
"passive-48v-4pair",
"",
null
],
"type": "string",
"description": "* `type1-ieee802.3af` - 802.3af (Type 1)\n* `type2-ieee802.3at` - 802.3at (Type 2)\n* `type3-ieee802.3bt` - 802.3bt (Type 3)\n* `type4-ieee802.3bt` - 802.3bt (Type 4)\n* `passive-24v-2pair` - Passive 24V (2-pair)\n* `passive-24v-4pair` - Passive 24V (4-pair)\n* `passive-48v-2pair` - Passive 48V (2-pair)\n* `passive-48v-4pair` - Passive 48V (4-pair)",
"x-spec-enum-id": "74bd3be4012f6da9",
"nullable": true
},
"rf_channel_frequency": {
"type": "number",
"format": "double",
"maximum": 100000,
"minimum": -100000,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true,
"title": "Channel frequency (MHz)",
"description": "Populated by selected channel (if set)"
},
"rf_channel_width": {
"type": "number",
"format": "double",
"maximum": 10000,
"minimum": -10000,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true,
"title": "Channel width (MHz)",
"description": "Populated by selected channel (if set)"
},
"tx_power": {
"type": "integer",
"maximum": 127,
"minimum": -40,
"nullable": true,
"title": "Transmit power (dBm)"
},
"untagged_vlan": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefVLANRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"tagged_vlans": {
"type": "array",
"items": {
"type": "integer"
}
},
"qinq_svlan": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefVLANRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"vlan_translation_policy": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefVLANTranslationPolicyRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"mark_connected": {
"type": "boolean",
"description": "Treat as if a cable is connected"
},
"wireless_lans": {
"type": "array",
"items": {
"type": "integer"
}
},
"vrf": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefVRFRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedWritableInterfaceTemplateRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"device_type": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefDeviceTypeRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"module_type": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleTypeRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"description": "{module} is accepted as a substitution for the module bay position when attached to a module type.",
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"enum": [
"virtual",
"bridge",
"lag",
"100base-fx",
"100base-lfx",
"100base-tx",
"100base-t1",
"1000base-t",
"1000base-sx",
"1000base-lx",
"1000base-tx",
"2.5gbase-t",
"5gbase-t",
"10gbase-t",
"10gbase-cx4",
"100base-x-sfp",
"1000base-x-gbic",
"1000base-x-sfp",
"10gbase-x-sfpp",
"10gbase-x-xfp",
"10gbase-x-xenpak",
"10gbase-x-x2",
"25gbase-x-sfp28",
"50gbase-x-sfp56",
"40gbase-x-qsfpp",
"50gbase-x-sfp28",
"100gbase-x-cfp",
"100gbase-x-cfp2",
"200gbase-x-cfp2",
"400gbase-x-cfp2",
"100gbase-x-cfp4",
"100gbase-x-cxp",
"100gbase-x-cpak",
"100gbase-x-dsfp",
"100gbase-x-sfpdd",
"100gbase-x-qsfp28",
"100gbase-x-qsfpdd",
"200gbase-x-qsfp56",
"200gbase-x-qsfpdd",
"400gbase-x-qsfp112",
"400gbase-x-qsfpdd",
"400gbase-x-osfp",
"400gbase-x-osfp-rhs",
"400gbase-x-cdfp",
"400gbase-x-cfp8",
"800gbase-x-qsfpdd",
"800gbase-x-osfp",
"1000base-kx",
"2.5gbase-kx",
"5gbase-kr",
"10gbase-kr",
"10gbase-kx4",
"25gbase-kr",
"40gbase-kr4",
"50gbase-kr",
"100gbase-kp4",
"100gbase-kr2",
"100gbase-kr4",
"ieee802.11a",
"ieee802.11g",
"ieee802.11n",
"ieee802.11ac",
"ieee802.11ad",
"ieee802.11ax",
"ieee802.11ay",
"ieee802.11be",
"ieee802.15.1",
"ieee802.15.4",
"other-wireless",
"gsm",
"cdma",
"lte",
"4g",
"5g",
"sonet-oc3",
"sonet-oc12",
"sonet-oc48",
"sonet-oc192",
"sonet-oc768",
"sonet-oc1920",
"sonet-oc3840",
"1gfc-sfp",
"2gfc-sfp",
"4gfc-sfp",
"8gfc-sfpp",
"16gfc-sfpp",
"32gfc-sfp28",
"32gfc-sfpp",
"64gfc-qsfpp",
"64gfc-sfpdd",
"64gfc-sfpp",
"128gfc-qsfp28",
"infiniband-sdr",
"infiniband-ddr",
"infiniband-qdr",
"infiniband-fdr10",
"infiniband-fdr",
"infiniband-edr",
"infiniband-hdr",
"infiniband-ndr",
"infiniband-xdr",
"t1",
"e1",
"t3",
"e3",
"xdsl",
"docsis",
"moca",
"bpon",
"epon",
"10g-epon",
"gpon",
"xg-pon",
"xgs-pon",
"ng-pon2",
"25g-pon",
"50g-pon",
"cisco-stackwise",
"cisco-stackwise-plus",
"cisco-flexstack",
"cisco-flexstack-plus",
"cisco-stackwise-80",
"cisco-stackwise-160",
"cisco-stackwise-320",
"cisco-stackwise-480",
"cisco-stackwise-1t",
"juniper-vcp",
"extreme-summitstack",
"extreme-summitstack-128",
"extreme-summitstack-256",
"extreme-summitstack-512",
"other"
],
"type": "string",
"description": "* `virtual` - Virtual\n* `bridge` - Bridge\n* `lag` - Link Aggregation Group (LAG)\n* `100base-fx` - 100BASE-FX (10/100ME FIBER)\n* `100base-lfx` - 100BASE-LFX (10/100ME FIBER)\n* `100base-tx` - 100BASE-TX (10/100ME)\n* `100base-t1` - 100BASE-T1 (10/100ME Single Pair)\n* `1000base-t` - 1000BASE-T (1GE)\n* `1000base-sx` - 1000BASE-SX (1GE)\n* `1000base-lx` - 1000BASE-LX (1GE)\n* `1000base-tx` - 1000BASE-TX (1GE)\n* `2.5gbase-t` - 2.5GBASE-T (2.5GE)\n* `5gbase-t` - 5GBASE-T (5GE)\n* `10gbase-t` - 10GBASE-T (10GE)\n* `10gbase-cx4` - 10GBASE-CX4 (10GE)\n* `100base-x-sfp` - SFP (100ME)\n* `1000base-x-gbic` - GBIC (1GE)\n* `1000base-x-sfp` - SFP (1GE)\n* `10gbase-x-sfpp` - SFP+ (10GE)\n* `10gbase-x-xfp` - XFP (10GE)\n* `10gbase-x-xenpak` - XENPAK (10GE)\n* `10gbase-x-x2` - X2 (10GE)\n* `25gbase-x-sfp28` - SFP28 (25GE)\n* `50gbase-x-sfp56` - SFP56 (50GE)\n* `40gbase-x-qsfpp` - QSFP+ (40GE)\n* `50gbase-x-sfp28` - QSFP28 (50GE)\n* `100gbase-x-cfp` - CFP (100GE)\n* `100gbase-x-cfp2` - CFP2 (100GE)\n* `200gbase-x-cfp2` - CFP2 (200GE)\n* `400gbase-x-cfp2` - CFP2 (400GE)\n* `100gbase-x-cfp4` - CFP4 (100GE)\n* `100gbase-x-cxp` - CXP (100GE)\n* `100gbase-x-cpak` - Cisco CPAK (100GE)\n* `100gbase-x-dsfp` - DSFP (100GE)\n* `100gbase-x-sfpdd` - SFP-DD (100GE)\n* `100gbase-x-qsfp28` - QSFP28 (100GE)\n* `100gbase-x-qsfpdd` - QSFP-DD (100GE)\n* `200gbase-x-qsfp56` - QSFP56 (200GE)\n* `200gbase-x-qsfpdd` - QSFP-DD (200GE)\n* `400gbase-x-qsfp112` - QSFP112 (400GE)\n* `400gbase-x-qsfpdd` - QSFP-DD (400GE)\n* `400gbase-x-osfp` - OSFP (400GE)\n* `400gbase-x-osfp-rhs` - OSFP-RHS (400GE)\n* `400gbase-x-cdfp` - CDFP (400GE)\n* `400gbase-x-cfp8` - CPF8 (400GE)\n* `800gbase-x-qsfpdd` - QSFP-DD (800GE)\n* `800gbase-x-osfp` - OSFP (800GE)\n* `1000base-kx` - 1000BASE-KX (1GE)\n* `2.5gbase-kx` - 2.5GBASE-KX (2.5GE)\n* `5gbase-kr` - 5GBASE-KR (5GE)\n* `10gbase-kr` - 10GBASE-KR (10GE)\n* `10gbase-kx4` - 10GBASE-KX4 (10GE)\n* `25gbase-kr` - 25GBASE-KR (25GE)\n* `40gbase-kr4` - 40GBASE-KR4 (40GE)\n* `50gbase-kr` - 50GBASE-KR (50GE)\n* `100gbase-kp4` - 100GBASE-KP4 (100GE)\n* `100gbase-kr2` - 100GBASE-KR2 (100GE)\n* `100gbase-kr4` - 100GBASE-KR4 (100GE)\n* `ieee802.11a` - IEEE 802.11a\n* `ieee802.11g` - IEEE 802.11b/g\n* `ieee802.11n` - IEEE 802.11n\n* `ieee802.11ac` - IEEE 802.11ac\n* `ieee802.11ad` - IEEE 802.11ad\n* `ieee802.11ax` - IEEE 802.11ax\n* `ieee802.11ay` - IEEE 802.11ay\n* `ieee802.11be` - IEEE 802.11be\n* `ieee802.15.1` - IEEE 802.15.1 (Bluetooth)\n* `ieee802.15.4` - IEEE 802.15.4 (LR-WPAN)\n* `other-wireless` - Other (Wireless)\n* `gsm` - GSM\n* `cdma` - CDMA\n* `lte` - LTE\n* `4g` - 4G\n* `5g` - 5G\n* `sonet-oc3` - OC-3/STM-1\n* `sonet-oc12` - OC-12/STM-4\n* `sonet-oc48` - OC-48/STM-16\n* `sonet-oc192` - OC-192/STM-64\n* `sonet-oc768` - OC-768/STM-256\n* `sonet-oc1920` - OC-1920/STM-640\n* `sonet-oc3840` - OC-3840/STM-1234\n* `1gfc-sfp` - SFP (1GFC)\n* `2gfc-sfp` - SFP (2GFC)\n* `4gfc-sfp` - SFP (4GFC)\n* `8gfc-sfpp` - SFP+ (8GFC)\n* `16gfc-sfpp` - SFP+ (16GFC)\n* `32gfc-sfp28` - SFP28 (32GFC)\n* `32gfc-sfpp` - SFP+ (32GFC)\n* `64gfc-qsfpp` - QSFP+ (64GFC)\n* `64gfc-sfpdd` - SFP-DD (64GFC)\n* `64gfc-sfpp` - SFP+ (64GFC)\n* `128gfc-qsfp28` - QSFP28 (128GFC)\n* `infiniband-sdr` - SDR (2 Gbps)\n* `infiniband-ddr` - DDR (4 Gbps)\n* `infiniband-qdr` - QDR (8 Gbps)\n* `infiniband-fdr10` - FDR10 (10 Gbps)\n* `infiniband-fdr` - FDR (13.5 Gbps)\n* `infiniband-edr` - EDR (25 Gbps)\n* `infiniband-hdr` - HDR (50 Gbps)\n* `infiniband-ndr` - NDR (100 Gbps)\n* `infiniband-xdr` - XDR (250 Gbps)\n* `t1` - T1 (1.544 Mbps)\n* `e1` - E1 (2.048 Mbps)\n* `t3` - T3 (45 Mbps)\n* `e3` - E3 (34 Mbps)\n* `xdsl` - xDSL\n* `docsis` - DOCSIS\n* `moca` - MoCA\n* `bpon` - BPON (622 Mbps / 155 Mbps)\n* `epon` - EPON (1 Gbps)\n* `10g-epon` - 10G-EPON (10 Gbps)\n* `gpon` - GPON (2.5 Gbps / 1.25 Gbps)\n* `xg-pon` - XG-PON (10 Gbps / 2.5 Gbps)\n* `xgs-pon` - XGS-PON (10 Gbps)\n* `ng-pon2` - NG-PON2 (TWDM-PON) (4x10 Gbps)\n* `25g-pon` - 25G-PON (25 Gbps)\n* `50g-pon` - 50G-PON (50 Gbps)\n* `cisco-stackwise` - Cisco StackWise\n* `cisco-stackwise-plus` - Cisco StackWise Plus\n* `cisco-flexstack` - Cisco FlexStack\n* `cisco-flexstack-plus` - Cisco FlexStack Plus\n* `cisco-stackwise-80` - Cisco StackWise-80\n* `cisco-stackwise-160` - Cisco StackWise-160\n* `cisco-stackwise-320` - Cisco StackWise-320\n* `cisco-stackwise-480` - Cisco StackWise-480\n* `cisco-stackwise-1t` - Cisco StackWise-1T\n* `juniper-vcp` - Juniper VCP\n* `extreme-summitstack` - Extreme SummitStack\n* `extreme-summitstack-128` - Extreme SummitStack-128\n* `extreme-summitstack-256` - Extreme SummitStack-256\n* `extreme-summitstack-512` - Extreme SummitStack-512\n* `other` - Other",
"x-spec-enum-id": "8c4c5e112f77a383"
},
"enabled": {
"type": "boolean"
},
"mgmt_only": {
"type": "boolean",
"title": "Management only"
},
"description": {
"type": "string",
"maxLength": 200
},
"bridge": {
"type": "integer",
"nullable": true,
"title": "Bridge interface"
},
"poe_mode": {
"enum": [
"pd",
"pse",
"",
null
],
"type": "string",
"description": "* `pd` - PD\n* `pse` - PSE",
"x-spec-enum-id": "2f2fe6dcdc7772bd",
"nullable": true
},
"poe_type": {
"enum": [
"type1-ieee802.3af",
"type2-ieee802.3at",
"type3-ieee802.3bt",
"type4-ieee802.3bt",
"passive-24v-2pair",
"passive-24v-4pair",
"passive-48v-2pair",
"passive-48v-4pair",
"",
null
],
"type": "string",
"description": "* `type1-ieee802.3af` - 802.3af (Type 1)\n* `type2-ieee802.3at` - 802.3at (Type 2)\n* `type3-ieee802.3bt` - 802.3bt (Type 3)\n* `type4-ieee802.3bt` - 802.3bt (Type 4)\n* `passive-24v-2pair` - Passive 24V (2-pair)\n* `passive-24v-4pair` - Passive 24V (4-pair)\n* `passive-48v-2pair` - Passive 48V (2-pair)\n* `passive-48v-4pair` - Passive 48V (4-pair)",
"x-spec-enum-id": "74bd3be4012f6da9",
"nullable": true
},
"rf_role": {
"enum": [
"ap",
"station",
"",
null
],
"type": "string",
"description": "* `ap` - Access point\n* `station` - Station",
"x-spec-enum-id": "d2772dbea88b0fb1",
"nullable": true,
"title": "Wireless role"
}
}
},
"PatchedWritableInventoryItemRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"device": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDeviceRequest"
}
]
},
"parent": {
"type": "integer",
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"status": {
"enum": [
"offline",
"active",
"planned",
"staged",
"failed",
"decommissioning"
],
"type": "string",
"description": "* `offline` - Offline\n* `active` - Active\n* `planned` - Planned\n* `staged` - Staged\n* `failed` - Failed\n* `decommissioning` - Decommissioning",
"x-spec-enum-id": "2217e87d0c3efdda"
},
"role": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefInventoryItemRoleRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"manufacturer": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefManufacturerRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"part_id": {
"type": "string",
"description": "Manufacturer-assigned part identifier",
"maxLength": 50
},
"serial": {
"type": "string",
"title": "Serial number",
"maxLength": 50
},
"asset_tag": {
"type": "string",
"nullable": true,
"description": "A unique tag used to identify this item",
"maxLength": 50
},
"discovered": {
"type": "boolean",
"description": "This item was automatically discovered"
},
"description": {
"type": "string",
"maxLength": 200
},
"component_type": {
"type": "string",
"nullable": true
},
"component_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64",
"nullable": true
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedWritableJournalEntryRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"assigned_object_type": {
"type": "string"
},
"assigned_object_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64"
},
"created_by": {
"type": "integer",
"nullable": true
},
"kind": {
"enum": [
"info",
"success",
"warning",
"danger"
],
"type": "string",
"description": "* `info` - Info\n* `success` - Success\n* `warning` - Warning\n* `danger` - Danger",
"x-spec-enum-id": "a21af280f632fa34"
},
"comments": {
"type": "string",
"minLength": 1
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedWritableL2VPNRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"identifier": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"format": "int64",
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"type": {
"enum": [
"vpws",
"vpls",
"vxlan",
"vxlan-evpn",
"mpls-evpn",
"pbb-evpn",
"evpn-vpws",
"epl",
"evpl",
"ep-lan",
"evp-lan",
"ep-tree",
"evp-tree",
"spb"
],
"type": "string",
"description": "* `vpws` - VPWS\n* `vpls` - VPLS\n* `vxlan` - VXLAN\n* `vxlan-evpn` - VXLAN-EVPN\n* `mpls-evpn` - MPLS EVPN\n* `pbb-evpn` - PBB EVPN\n* `evpn-vpws` - EVPN VPWS\n* `epl` - EPL\n* `evpl` - EVPL\n* `ep-lan` - Ethernet Private LAN\n* `evp-lan` - Ethernet Virtual Private LAN\n* `ep-tree` - Ethernet Private Tree\n* `evp-tree` - Ethernet Virtual Private Tree\n* `spb` - SPB",
"x-spec-enum-id": "730136816a2885f9"
},
"status": {
"enum": [
"active",
"planned",
"decommissioning"
],
"type": "string",
"description": "* `active` - Active\n* `planned` - Planned\n* `decommissioning` - Decommissioning",
"x-spec-enum-id": "937bacafb9d5d4bb"
},
"import_targets": {
"type": "array",
"items": {
"type": "integer"
}
},
"export_targets": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedWritableLocationRequest": {
"type": "object",
"description": "Extends PrimaryModelSerializer to include MPTT support.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"site": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefSiteRequest"
}
]
},
"parent": {
"type": "integer",
"nullable": true
},
"status": {
"enum": [
"planned",
"staging",
"active",
"decommissioning",
"retired"
],
"type": "string",
"description": "* `planned` - Planned\n* `staging` - Staging\n* `active` - Active\n* `decommissioning` - Decommissioning\n* `retired` - Retired",
"x-spec-enum-id": "e363a8ddb138be50"
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"facility": {
"type": "string",
"description": "Local facility ID or description",
"maxLength": 50
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"comments": {
"type": "string"
}
}
},
"PatchedWritableModuleRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"device": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDeviceRequest"
}
]
},
"module_bay": {
"type": "integer"
},
"module_type": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefModuleTypeRequest"
}
]
},
"status": {
"enum": [
"offline",
"active",
"planned",
"staged",
"failed",
"decommissioning"
],
"type": "string",
"description": "* `offline` - Offline\n* `active` - Active\n* `planned` - Planned\n* `staged` - Staged\n* `failed` - Failed\n* `decommissioning` - Decommissioning",
"x-spec-enum-id": "2217e87d0c3efdda"
},
"serial": {
"type": "string",
"title": "Serial number",
"maxLength": 50
},
"asset_tag": {
"type": "string",
"nullable": true,
"description": "A unique tag used to identify this device",
"maxLength": 50
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedWritableModuleTypeRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"profile": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleTypeProfileRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"manufacturer": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefManufacturerRequest"
}
]
},
"model": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"part_number": {
"type": "string",
"description": "Discrete part number (optional)",
"maxLength": 50
},
"airflow": {
"enum": [
"front-to-rear",
"rear-to-front",
"left-to-right",
"right-to-left",
"side-to-rear",
"passive",
"",
null
],
"type": "string",
"description": "* `front-to-rear` - Front to rear\n* `rear-to-front` - Rear to front\n* `left-to-right` - Left to right\n* `right-to-left` - Right to left\n* `side-to-rear` - Side to rear\n* `passive` - Passive",
"x-spec-enum-id": "f6e5562e0e98d69d",
"nullable": true
},
"weight": {
"type": "number",
"format": "double",
"maximum": 1000000,
"minimum": -1000000,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true
},
"weight_unit": {
"enum": [
"kg",
"g",
"lb",
"oz",
"",
null
],
"type": "string",
"description": "* `kg` - Kilograms\n* `g` - Grams\n* `lb` - Pounds\n* `oz` - Ounces",
"x-spec-enum-id": "7c1876f422815884",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"attributes": {
"nullable": true
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedWritablePlatformRequest": {
"type": "object",
"description": "Extends PrimaryModelSerializer to include MPTT support.",
"properties": {
"parent": {
"type": "integer",
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"manufacturer": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefManufacturerRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"config_template": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefConfigTemplateRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedWritablePowerFeedRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"power_panel": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefPowerPanelRequest"
}
]
},
"rack": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefRackRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"status": {
"enum": [
"offline",
"active",
"planned",
"failed"
],
"type": "string",
"description": "* `offline` - Offline\n* `active` - Active\n* `planned` - Planned\n* `failed` - Failed",
"x-spec-enum-id": "b77fc919138c12f6"
},
"type": {
"enum": [
"primary",
"redundant"
],
"type": "string",
"description": "* `primary` - Primary\n* `redundant` - Redundant",
"x-spec-enum-id": "093a164236819eb8"
},
"supply": {
"enum": [
"ac",
"dc"
],
"type": "string",
"description": "* `ac` - AC\n* `dc` - DC",
"x-spec-enum-id": "1b6d99616ca6412b"
},
"phase": {
"enum": [
"single-phase",
"three-phase"
],
"type": "string",
"description": "* `single-phase` - Single phase\n* `three-phase` - Three-phase",
"x-spec-enum-id": "994bc0696f4df57f"
},
"voltage": {
"type": "integer",
"maximum": 32767,
"minimum": -32768
},
"amperage": {
"type": "integer",
"maximum": 32767,
"minimum": 1
},
"max_utilization": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Maximum permissible draw (percentage)"
},
"mark_connected": {
"type": "boolean",
"description": "Treat as if a cable is connected"
},
"description": {
"type": "string",
"maxLength": 200
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedWritablePowerOutletRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"device": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDeviceRequest"
}
]
},
"module": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"enum": [
"iec-60320-c5",
"iec-60320-c7",
"iec-60320-c13",
"iec-60320-c15",
"iec-60320-c17",
"iec-60320-c19",
"iec-60320-c21",
"iec-60309-p-n-e-4h",
"iec-60309-p-n-e-6h",
"iec-60309-p-n-e-9h",
"iec-60309-2p-e-4h",
"iec-60309-2p-e-6h",
"iec-60309-2p-e-9h",
"iec-60309-3p-e-4h",
"iec-60309-3p-e-6h",
"iec-60309-3p-e-9h",
"iec-60309-3p-n-e-4h",
"iec-60309-3p-n-e-6h",
"iec-60309-3p-n-e-9h",
"iec-60906-1",
"nbr-14136-10a",
"nbr-14136-20a",
"nema-1-15r",
"nema-5-15r",
"nema-5-20r",
"nema-5-30r",
"nema-5-50r",
"nema-6-15r",
"nema-6-20r",
"nema-6-30r",
"nema-6-50r",
"nema-10-30r",
"nema-10-50r",
"nema-14-20r",
"nema-14-30r",
"nema-14-50r",
"nema-14-60r",
"nema-15-15r",
"nema-15-20r",
"nema-15-30r",
"nema-15-50r",
"nema-15-60r",
"nema-l1-15r",
"nema-l5-15r",
"nema-l5-20r",
"nema-l5-30r",
"nema-l5-50r",
"nema-l6-15r",
"nema-l6-20r",
"nema-l6-30r",
"nema-l6-50r",
"nema-l10-30r",
"nema-l14-20r",
"nema-l14-30r",
"nema-l14-50r",
"nema-l14-60r",
"nema-l15-20r",
"nema-l15-30r",
"nema-l15-50r",
"nema-l15-60r",
"nema-l21-20r",
"nema-l21-30r",
"nema-l22-20r",
"nema-l22-30r",
"CS6360C",
"CS6364C",
"CS8164C",
"CS8264C",
"CS8364C",
"CS8464C",
"ita-e",
"ita-f",
"ita-g",
"ita-h",
"ita-i",
"ita-j",
"ita-k",
"ita-l",
"ita-m",
"ita-n",
"ita-o",
"ita-multistandard",
"usb-a",
"usb-micro-b",
"usb-c",
"molex-micro-fit-1x2",
"molex-micro-fit-2x2",
"molex-micro-fit-2x4",
"dc-terminal",
"eaton-c39",
"hdot-cx",
"saf-d-grid",
"neutrik-powercon-20a",
"neutrik-powercon-32a",
"neutrik-powercon-true1",
"neutrik-powercon-true1-top",
"ubiquiti-smartpower",
"hardwired",
"other",
"",
null
],
"type": "string",
"x-spec-enum-id": "8f9617d2648ab261",
"nullable": true,
"description": "Physical port type\n\n* `iec-60320-c5` - C5\n* `iec-60320-c7` - C7\n* `iec-60320-c13` - C13\n* `iec-60320-c15` - C15\n* `iec-60320-c17` - C17\n* `iec-60320-c19` - C19\n* `iec-60320-c21` - C21\n* `iec-60309-p-n-e-4h` - P+N+E 4H\n* `iec-60309-p-n-e-6h` - P+N+E 6H\n* `iec-60309-p-n-e-9h` - P+N+E 9H\n* `iec-60309-2p-e-4h` - 2P+E 4H\n* `iec-60309-2p-e-6h` - 2P+E 6H\n* `iec-60309-2p-e-9h` - 2P+E 9H\n* `iec-60309-3p-e-4h` - 3P+E 4H\n* `iec-60309-3p-e-6h` - 3P+E 6H\n* `iec-60309-3p-e-9h` - 3P+E 9H\n* `iec-60309-3p-n-e-4h` - 3P+N+E 4H\n* `iec-60309-3p-n-e-6h` - 3P+N+E 6H\n* `iec-60309-3p-n-e-9h` - 3P+N+E 9H\n* `iec-60906-1` - IEC 60906-1\n* `nbr-14136-10a` - 2P+T 10A (NBR 14136)\n* `nbr-14136-20a` - 2P+T 20A (NBR 14136)\n* `nema-1-15r` - NEMA 1-15R\n* `nema-5-15r` - NEMA 5-15R\n* `nema-5-20r` - NEMA 5-20R\n* `nema-5-30r` - NEMA 5-30R\n* `nema-5-50r` - NEMA 5-50R\n* `nema-6-15r` - NEMA 6-15R\n* `nema-6-20r` - NEMA 6-20R\n* `nema-6-30r` - NEMA 6-30R\n* `nema-6-50r` - NEMA 6-50R\n* `nema-10-30r` - NEMA 10-30R\n* `nema-10-50r` - NEMA 10-50R\n* `nema-14-20r` - NEMA 14-20R\n* `nema-14-30r` - NEMA 14-30R\n* `nema-14-50r` - NEMA 14-50R\n* `nema-14-60r` - NEMA 14-60R\n* `nema-15-15r` - NEMA 15-15R\n* `nema-15-20r` - NEMA 15-20R\n* `nema-15-30r` - NEMA 15-30R\n* `nema-15-50r` - NEMA 15-50R\n* `nema-15-60r` - NEMA 15-60R\n* `nema-l1-15r` - NEMA L1-15R\n* `nema-l5-15r` - NEMA L5-15R\n* `nema-l5-20r` - NEMA L5-20R\n* `nema-l5-30r` - NEMA L5-30R\n* `nema-l5-50r` - NEMA L5-50R\n* `nema-l6-15r` - NEMA L6-15R\n* `nema-l6-20r` - NEMA L6-20R\n* `nema-l6-30r` - NEMA L6-30R\n* `nema-l6-50r` - NEMA L6-50R\n* `nema-l10-30r` - NEMA L10-30R\n* `nema-l14-20r` - NEMA L14-20R\n* `nema-l14-30r` - NEMA L14-30R\n* `nema-l14-50r` - NEMA L14-50R\n* `nema-l14-60r` - NEMA L14-60R\n* `nema-l15-20r` - NEMA L15-20R\n* `nema-l15-30r` - NEMA L15-30R\n* `nema-l15-50r` - NEMA L15-50R\n* `nema-l15-60r` - NEMA L15-60R\n* `nema-l21-20r` - NEMA L21-20R\n* `nema-l21-30r` - NEMA L21-30R\n* `nema-l22-20r` - NEMA L22-20R\n* `nema-l22-30r` - NEMA L22-30R\n* `CS6360C` - CS6360C\n* `CS6364C` - CS6364C\n* `CS8164C` - CS8164C\n* `CS8264C` - CS8264C\n* `CS8364C` - CS8364C\n* `CS8464C` - CS8464C\n* `ita-e` - ITA Type E (CEE 7/5)\n* `ita-f` - ITA Type F (CEE 7/3)\n* `ita-g` - ITA Type G (BS 1363)\n* `ita-h` - ITA Type H\n* `ita-i` - ITA Type I\n* `ita-j` - ITA Type J\n* `ita-k` - ITA Type K\n* `ita-l` - ITA Type L (CEI 23-50)\n* `ita-m` - ITA Type M (BS 546)\n* `ita-n` - ITA Type N\n* `ita-o` - ITA Type O\n* `ita-multistandard` - ITA Multistandard\n* `usb-a` - USB Type A\n* `usb-micro-b` - USB Micro B\n* `usb-c` - USB Type C\n* `molex-micro-fit-1x2` - Molex Micro-Fit 1x2\n* `molex-micro-fit-2x2` - Molex Micro-Fit 2x2\n* `molex-micro-fit-2x4` - Molex Micro-Fit 2x4\n* `dc-terminal` - DC Terminal\n* `eaton-c39` - Eaton C39\n* `hdot-cx` - HDOT Cx\n* `saf-d-grid` - Saf-D-Grid\n* `neutrik-powercon-20a` - Neutrik powerCON (20A)\n* `neutrik-powercon-32a` - Neutrik powerCON (32A)\n* `neutrik-powercon-true1` - Neutrik powerCON TRUE1\n* `neutrik-powercon-true1-top` - Neutrik powerCON TRUE1 TOP\n* `ubiquiti-smartpower` - Ubiquiti SmartPower\n* `hardwired` - Hardwired\n* `other` - Other"
},
"status": {
"enum": [
"enabled",
"disabled",
"faulty"
],
"type": "string",
"description": "* `enabled` - Enabled\n* `disabled` - Disabled\n* `faulty` - Faulty",
"x-spec-enum-id": "1024f7deaed962d7"
},
"color": {
"type": "string",
"pattern": "^[0-9a-f]{6}$",
"maxLength": 6
},
"power_port": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefPowerPortRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"feed_leg": {
"enum": [
"A",
"B",
"C",
"",
null
],
"type": "string",
"x-spec-enum-id": "a4902339df0b7c06",
"nullable": true,
"description": "Phase (for three-phase feeds)\n\n* `A` - A\n* `B` - B\n* `C` - C"
},
"description": {
"type": "string",
"maxLength": 200
},
"mark_connected": {
"type": "boolean",
"description": "Treat as if a cable is connected"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedWritablePowerOutletTemplateRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"device_type": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefDeviceTypeRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"module_type": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleTypeRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"description": "{module} is accepted as a substitution for the module bay position when attached to a module type.",
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"enum": [
"iec-60320-c5",
"iec-60320-c7",
"iec-60320-c13",
"iec-60320-c15",
"iec-60320-c17",
"iec-60320-c19",
"iec-60320-c21",
"iec-60309-p-n-e-4h",
"iec-60309-p-n-e-6h",
"iec-60309-p-n-e-9h",
"iec-60309-2p-e-4h",
"iec-60309-2p-e-6h",
"iec-60309-2p-e-9h",
"iec-60309-3p-e-4h",
"iec-60309-3p-e-6h",
"iec-60309-3p-e-9h",
"iec-60309-3p-n-e-4h",
"iec-60309-3p-n-e-6h",
"iec-60309-3p-n-e-9h",
"iec-60906-1",
"nbr-14136-10a",
"nbr-14136-20a",
"nema-1-15r",
"nema-5-15r",
"nema-5-20r",
"nema-5-30r",
"nema-5-50r",
"nema-6-15r",
"nema-6-20r",
"nema-6-30r",
"nema-6-50r",
"nema-10-30r",
"nema-10-50r",
"nema-14-20r",
"nema-14-30r",
"nema-14-50r",
"nema-14-60r",
"nema-15-15r",
"nema-15-20r",
"nema-15-30r",
"nema-15-50r",
"nema-15-60r",
"nema-l1-15r",
"nema-l5-15r",
"nema-l5-20r",
"nema-l5-30r",
"nema-l5-50r",
"nema-l6-15r",
"nema-l6-20r",
"nema-l6-30r",
"nema-l6-50r",
"nema-l10-30r",
"nema-l14-20r",
"nema-l14-30r",
"nema-l14-50r",
"nema-l14-60r",
"nema-l15-20r",
"nema-l15-30r",
"nema-l15-50r",
"nema-l15-60r",
"nema-l21-20r",
"nema-l21-30r",
"nema-l22-20r",
"nema-l22-30r",
"CS6360C",
"CS6364C",
"CS8164C",
"CS8264C",
"CS8364C",
"CS8464C",
"ita-e",
"ita-f",
"ita-g",
"ita-h",
"ita-i",
"ita-j",
"ita-k",
"ita-l",
"ita-m",
"ita-n",
"ita-o",
"ita-multistandard",
"usb-a",
"usb-micro-b",
"usb-c",
"molex-micro-fit-1x2",
"molex-micro-fit-2x2",
"molex-micro-fit-2x4",
"dc-terminal",
"eaton-c39",
"hdot-cx",
"saf-d-grid",
"neutrik-powercon-20a",
"neutrik-powercon-32a",
"neutrik-powercon-true1",
"neutrik-powercon-true1-top",
"ubiquiti-smartpower",
"hardwired",
"other",
"",
null
],
"type": "string",
"description": "* `iec-60320-c5` - C5\n* `iec-60320-c7` - C7\n* `iec-60320-c13` - C13\n* `iec-60320-c15` - C15\n* `iec-60320-c17` - C17\n* `iec-60320-c19` - C19\n* `iec-60320-c21` - C21\n* `iec-60309-p-n-e-4h` - P+N+E 4H\n* `iec-60309-p-n-e-6h` - P+N+E 6H\n* `iec-60309-p-n-e-9h` - P+N+E 9H\n* `iec-60309-2p-e-4h` - 2P+E 4H\n* `iec-60309-2p-e-6h` - 2P+E 6H\n* `iec-60309-2p-e-9h` - 2P+E 9H\n* `iec-60309-3p-e-4h` - 3P+E 4H\n* `iec-60309-3p-e-6h` - 3P+E 6H\n* `iec-60309-3p-e-9h` - 3P+E 9H\n* `iec-60309-3p-n-e-4h` - 3P+N+E 4H\n* `iec-60309-3p-n-e-6h` - 3P+N+E 6H\n* `iec-60309-3p-n-e-9h` - 3P+N+E 9H\n* `iec-60906-1` - IEC 60906-1\n* `nbr-14136-10a` - 2P+T 10A (NBR 14136)\n* `nbr-14136-20a` - 2P+T 20A (NBR 14136)\n* `nema-1-15r` - NEMA 1-15R\n* `nema-5-15r` - NEMA 5-15R\n* `nema-5-20r` - NEMA 5-20R\n* `nema-5-30r` - NEMA 5-30R\n* `nema-5-50r` - NEMA 5-50R\n* `nema-6-15r` - NEMA 6-15R\n* `nema-6-20r` - NEMA 6-20R\n* `nema-6-30r` - NEMA 6-30R\n* `nema-6-50r` - NEMA 6-50R\n* `nema-10-30r` - NEMA 10-30R\n* `nema-10-50r` - NEMA 10-50R\n* `nema-14-20r` - NEMA 14-20R\n* `nema-14-30r` - NEMA 14-30R\n* `nema-14-50r` - NEMA 14-50R\n* `nema-14-60r` - NEMA 14-60R\n* `nema-15-15r` - NEMA 15-15R\n* `nema-15-20r` - NEMA 15-20R\n* `nema-15-30r` - NEMA 15-30R\n* `nema-15-50r` - NEMA 15-50R\n* `nema-15-60r` - NEMA 15-60R\n* `nema-l1-15r` - NEMA L1-15R\n* `nema-l5-15r` - NEMA L5-15R\n* `nema-l5-20r` - NEMA L5-20R\n* `nema-l5-30r` - NEMA L5-30R\n* `nema-l5-50r` - NEMA L5-50R\n* `nema-l6-15r` - NEMA L6-15R\n* `nema-l6-20r` - NEMA L6-20R\n* `nema-l6-30r` - NEMA L6-30R\n* `nema-l6-50r` - NEMA L6-50R\n* `nema-l10-30r` - NEMA L10-30R\n* `nema-l14-20r` - NEMA L14-20R\n* `nema-l14-30r` - NEMA L14-30R\n* `nema-l14-50r` - NEMA L14-50R\n* `nema-l14-60r` - NEMA L14-60R\n* `nema-l15-20r` - NEMA L15-20R\n* `nema-l15-30r` - NEMA L15-30R\n* `nema-l15-50r` - NEMA L15-50R\n* `nema-l15-60r` - NEMA L15-60R\n* `nema-l21-20r` - NEMA L21-20R\n* `nema-l21-30r` - NEMA L21-30R\n* `nema-l22-20r` - NEMA L22-20R\n* `nema-l22-30r` - NEMA L22-30R\n* `CS6360C` - CS6360C\n* `CS6364C` - CS6364C\n* `CS8164C` - CS8164C\n* `CS8264C` - CS8264C\n* `CS8364C` - CS8364C\n* `CS8464C` - CS8464C\n* `ita-e` - ITA Type E (CEE 7/5)\n* `ita-f` - ITA Type F (CEE 7/3)\n* `ita-g` - ITA Type G (BS 1363)\n* `ita-h` - ITA Type H\n* `ita-i` - ITA Type I\n* `ita-j` - ITA Type J\n* `ita-k` - ITA Type K\n* `ita-l` - ITA Type L (CEI 23-50)\n* `ita-m` - ITA Type M (BS 546)\n* `ita-n` - ITA Type N\n* `ita-o` - ITA Type O\n* `ita-multistandard` - ITA Multistandard\n* `usb-a` - USB Type A\n* `usb-micro-b` - USB Micro B\n* `usb-c` - USB Type C\n* `molex-micro-fit-1x2` - Molex Micro-Fit 1x2\n* `molex-micro-fit-2x2` - Molex Micro-Fit 2x2\n* `molex-micro-fit-2x4` - Molex Micro-Fit 2x4\n* `dc-terminal` - DC Terminal\n* `eaton-c39` - Eaton C39\n* `hdot-cx` - HDOT Cx\n* `saf-d-grid` - Saf-D-Grid\n* `neutrik-powercon-20a` - Neutrik powerCON (20A)\n* `neutrik-powercon-32a` - Neutrik powerCON (32A)\n* `neutrik-powercon-true1` - Neutrik powerCON TRUE1\n* `neutrik-powercon-true1-top` - Neutrik powerCON TRUE1 TOP\n* `ubiquiti-smartpower` - Ubiquiti SmartPower\n* `hardwired` - Hardwired\n* `other` - Other",
"x-spec-enum-id": "8f9617d2648ab261",
"nullable": true
},
"power_port": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefPowerPortTemplateRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"feed_leg": {
"enum": [
"A",
"B",
"C",
"",
null
],
"type": "string",
"x-spec-enum-id": "a4902339df0b7c06",
"nullable": true,
"description": "Phase (for three-phase feeds)\n\n* `A` - A\n* `B` - B\n* `C` - C"
},
"description": {
"type": "string",
"maxLength": 200
}
}
},
"PatchedWritablePowerPortRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"device": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDeviceRequest"
}
]
},
"module": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"enum": [
"iec-60320-c6",
"iec-60320-c8",
"iec-60320-c14",
"iec-60320-c16",
"iec-60320-c18",
"iec-60320-c20",
"iec-60320-c22",
"iec-60309-p-n-e-4h",
"iec-60309-p-n-e-6h",
"iec-60309-p-n-e-9h",
"iec-60309-2p-e-4h",
"iec-60309-2p-e-6h",
"iec-60309-2p-e-9h",
"iec-60309-3p-e-4h",
"iec-60309-3p-e-6h",
"iec-60309-3p-e-9h",
"iec-60309-3p-n-e-4h",
"iec-60309-3p-n-e-6h",
"iec-60309-3p-n-e-9h",
"iec-60906-1",
"nbr-14136-10a",
"nbr-14136-20a",
"nema-1-15p",
"nema-5-15p",
"nema-5-20p",
"nema-5-30p",
"nema-5-50p",
"nema-6-15p",
"nema-6-20p",
"nema-6-30p",
"nema-6-50p",
"nema-10-30p",
"nema-10-50p",
"nema-14-20p",
"nema-14-30p",
"nema-14-50p",
"nema-14-60p",
"nema-15-15p",
"nema-15-20p",
"nema-15-30p",
"nema-15-50p",
"nema-15-60p",
"nema-l1-15p",
"nema-l5-15p",
"nema-l5-20p",
"nema-l5-30p",
"nema-l5-50p",
"nema-l6-15p",
"nema-l6-20p",
"nema-l6-30p",
"nema-l6-50p",
"nema-l10-30p",
"nema-l14-20p",
"nema-l14-30p",
"nema-l14-50p",
"nema-l14-60p",
"nema-l15-20p",
"nema-l15-30p",
"nema-l15-50p",
"nema-l15-60p",
"nema-l21-20p",
"nema-l21-30p",
"nema-l22-20p",
"nema-l22-30p",
"cs6361c",
"cs6365c",
"cs8165c",
"cs8265c",
"cs8365c",
"cs8465c",
"ita-c",
"ita-e",
"ita-f",
"ita-ef",
"ita-g",
"ita-h",
"ita-i",
"ita-j",
"ita-k",
"ita-l",
"ita-m",
"ita-n",
"ita-o",
"usb-a",
"usb-b",
"usb-c",
"usb-mini-a",
"usb-mini-b",
"usb-micro-a",
"usb-micro-b",
"usb-micro-ab",
"usb-3-b",
"usb-3-micro-b",
"molex-micro-fit-1x2",
"molex-micro-fit-2x2",
"molex-micro-fit-2x4",
"dc-terminal",
"saf-d-grid",
"neutrik-powercon-20",
"neutrik-powercon-32",
"neutrik-powercon-true1",
"neutrik-powercon-true1-top",
"ubiquiti-smartpower",
"hardwired",
"other",
"",
null
],
"type": "string",
"x-spec-enum-id": "292850be2c08f7df",
"nullable": true,
"description": "Physical port type\n\n* `iec-60320-c6` - C6\n* `iec-60320-c8` - C8\n* `iec-60320-c14` - C14\n* `iec-60320-c16` - C16\n* `iec-60320-c18` - C18\n* `iec-60320-c20` - C20\n* `iec-60320-c22` - C22\n* `iec-60309-p-n-e-4h` - P+N+E 4H\n* `iec-60309-p-n-e-6h` - P+N+E 6H\n* `iec-60309-p-n-e-9h` - P+N+E 9H\n* `iec-60309-2p-e-4h` - 2P+E 4H\n* `iec-60309-2p-e-6h` - 2P+E 6H\n* `iec-60309-2p-e-9h` - 2P+E 9H\n* `iec-60309-3p-e-4h` - 3P+E 4H\n* `iec-60309-3p-e-6h` - 3P+E 6H\n* `iec-60309-3p-e-9h` - 3P+E 9H\n* `iec-60309-3p-n-e-4h` - 3P+N+E 4H\n* `iec-60309-3p-n-e-6h` - 3P+N+E 6H\n* `iec-60309-3p-n-e-9h` - 3P+N+E 9H\n* `iec-60906-1` - IEC 60906-1\n* `nbr-14136-10a` - 2P+T 10A (NBR 14136)\n* `nbr-14136-20a` - 2P+T 20A (NBR 14136)\n* `nema-1-15p` - NEMA 1-15P\n* `nema-5-15p` - NEMA 5-15P\n* `nema-5-20p` - NEMA 5-20P\n* `nema-5-30p` - NEMA 5-30P\n* `nema-5-50p` - NEMA 5-50P\n* `nema-6-15p` - NEMA 6-15P\n* `nema-6-20p` - NEMA 6-20P\n* `nema-6-30p` - NEMA 6-30P\n* `nema-6-50p` - NEMA 6-50P\n* `nema-10-30p` - NEMA 10-30P\n* `nema-10-50p` - NEMA 10-50P\n* `nema-14-20p` - NEMA 14-20P\n* `nema-14-30p` - NEMA 14-30P\n* `nema-14-50p` - NEMA 14-50P\n* `nema-14-60p` - NEMA 14-60P\n* `nema-15-15p` - NEMA 15-15P\n* `nema-15-20p` - NEMA 15-20P\n* `nema-15-30p` - NEMA 15-30P\n* `nema-15-50p` - NEMA 15-50P\n* `nema-15-60p` - NEMA 15-60P\n* `nema-l1-15p` - NEMA L1-15P\n* `nema-l5-15p` - NEMA L5-15P\n* `nema-l5-20p` - NEMA L5-20P\n* `nema-l5-30p` - NEMA L5-30P\n* `nema-l5-50p` - NEMA L5-50P\n* `nema-l6-15p` - NEMA L6-15P\n* `nema-l6-20p` - NEMA L6-20P\n* `nema-l6-30p` - NEMA L6-30P\n* `nema-l6-50p` - NEMA L6-50P\n* `nema-l10-30p` - NEMA L10-30P\n* `nema-l14-20p` - NEMA L14-20P\n* `nema-l14-30p` - NEMA L14-30P\n* `nema-l14-50p` - NEMA L14-50P\n* `nema-l14-60p` - NEMA L14-60P\n* `nema-l15-20p` - NEMA L15-20P\n* `nema-l15-30p` - NEMA L15-30P\n* `nema-l15-50p` - NEMA L15-50P\n* `nema-l15-60p` - NEMA L15-60P\n* `nema-l21-20p` - NEMA L21-20P\n* `nema-l21-30p` - NEMA L21-30P\n* `nema-l22-20p` - NEMA L22-20P\n* `nema-l22-30p` - NEMA L22-30P\n* `cs6361c` - CS6361C\n* `cs6365c` - CS6365C\n* `cs8165c` - CS8165C\n* `cs8265c` - CS8265C\n* `cs8365c` - CS8365C\n* `cs8465c` - CS8465C\n* `ita-c` - ITA Type C (CEE 7/16)\n* `ita-e` - ITA Type E (CEE 7/6)\n* `ita-f` - ITA Type F (CEE 7/4)\n* `ita-ef` - ITA Type E/F (CEE 7/7)\n* `ita-g` - ITA Type G (BS 1363)\n* `ita-h` - ITA Type H\n* `ita-i` - ITA Type I\n* `ita-j` - ITA Type J\n* `ita-k` - ITA Type K\n* `ita-l` - ITA Type L (CEI 23-50)\n* `ita-m` - ITA Type M (BS 546)\n* `ita-n` - ITA Type N\n* `ita-o` - ITA Type O\n* `usb-a` - USB Type A\n* `usb-b` - USB Type B\n* `usb-c` - USB Type C\n* `usb-mini-a` - USB Mini A\n* `usb-mini-b` - USB Mini B\n* `usb-micro-a` - USB Micro A\n* `usb-micro-b` - USB Micro B\n* `usb-micro-ab` - USB Micro AB\n* `usb-3-b` - USB 3.0 Type B\n* `usb-3-micro-b` - USB 3.0 Micro B\n* `molex-micro-fit-1x2` - Molex Micro-Fit 1x2\n* `molex-micro-fit-2x2` - Molex Micro-Fit 2x2\n* `molex-micro-fit-2x4` - Molex Micro-Fit 2x4\n* `dc-terminal` - DC Terminal\n* `saf-d-grid` - Saf-D-Grid\n* `neutrik-powercon-20` - Neutrik powerCON (20A)\n* `neutrik-powercon-32` - Neutrik powerCON (32A)\n* `neutrik-powercon-true1` - Neutrik powerCON TRUE1\n* `neutrik-powercon-true1-top` - Neutrik powerCON TRUE1 TOP\n* `ubiquiti-smartpower` - Ubiquiti SmartPower\n* `hardwired` - Hardwired\n* `other` - Other"
},
"maximum_draw": {
"type": "integer",
"maximum": 2147483647,
"minimum": 1,
"nullable": true,
"description": "Maximum power draw (watts)"
},
"allocated_draw": {
"type": "integer",
"maximum": 2147483647,
"minimum": 1,
"nullable": true,
"description": "Allocated power draw (watts)"
},
"description": {
"type": "string",
"maxLength": 200
},
"mark_connected": {
"type": "boolean",
"description": "Treat as if a cable is connected"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedWritablePowerPortTemplateRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"device_type": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefDeviceTypeRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"module_type": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleTypeRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"description": "{module} is accepted as a substitution for the module bay position when attached to a module type.",
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"enum": [
"iec-60320-c6",
"iec-60320-c8",
"iec-60320-c14",
"iec-60320-c16",
"iec-60320-c18",
"iec-60320-c20",
"iec-60320-c22",
"iec-60309-p-n-e-4h",
"iec-60309-p-n-e-6h",
"iec-60309-p-n-e-9h",
"iec-60309-2p-e-4h",
"iec-60309-2p-e-6h",
"iec-60309-2p-e-9h",
"iec-60309-3p-e-4h",
"iec-60309-3p-e-6h",
"iec-60309-3p-e-9h",
"iec-60309-3p-n-e-4h",
"iec-60309-3p-n-e-6h",
"iec-60309-3p-n-e-9h",
"iec-60906-1",
"nbr-14136-10a",
"nbr-14136-20a",
"nema-1-15p",
"nema-5-15p",
"nema-5-20p",
"nema-5-30p",
"nema-5-50p",
"nema-6-15p",
"nema-6-20p",
"nema-6-30p",
"nema-6-50p",
"nema-10-30p",
"nema-10-50p",
"nema-14-20p",
"nema-14-30p",
"nema-14-50p",
"nema-14-60p",
"nema-15-15p",
"nema-15-20p",
"nema-15-30p",
"nema-15-50p",
"nema-15-60p",
"nema-l1-15p",
"nema-l5-15p",
"nema-l5-20p",
"nema-l5-30p",
"nema-l5-50p",
"nema-l6-15p",
"nema-l6-20p",
"nema-l6-30p",
"nema-l6-50p",
"nema-l10-30p",
"nema-l14-20p",
"nema-l14-30p",
"nema-l14-50p",
"nema-l14-60p",
"nema-l15-20p",
"nema-l15-30p",
"nema-l15-50p",
"nema-l15-60p",
"nema-l21-20p",
"nema-l21-30p",
"nema-l22-20p",
"nema-l22-30p",
"cs6361c",
"cs6365c",
"cs8165c",
"cs8265c",
"cs8365c",
"cs8465c",
"ita-c",
"ita-e",
"ita-f",
"ita-ef",
"ita-g",
"ita-h",
"ita-i",
"ita-j",
"ita-k",
"ita-l",
"ita-m",
"ita-n",
"ita-o",
"usb-a",
"usb-b",
"usb-c",
"usb-mini-a",
"usb-mini-b",
"usb-micro-a",
"usb-micro-b",
"usb-micro-ab",
"usb-3-b",
"usb-3-micro-b",
"molex-micro-fit-1x2",
"molex-micro-fit-2x2",
"molex-micro-fit-2x4",
"dc-terminal",
"saf-d-grid",
"neutrik-powercon-20",
"neutrik-powercon-32",
"neutrik-powercon-true1",
"neutrik-powercon-true1-top",
"ubiquiti-smartpower",
"hardwired",
"other",
"",
null
],
"type": "string",
"description": "* `iec-60320-c6` - C6\n* `iec-60320-c8` - C8\n* `iec-60320-c14` - C14\n* `iec-60320-c16` - C16\n* `iec-60320-c18` - C18\n* `iec-60320-c20` - C20\n* `iec-60320-c22` - C22\n* `iec-60309-p-n-e-4h` - P+N+E 4H\n* `iec-60309-p-n-e-6h` - P+N+E 6H\n* `iec-60309-p-n-e-9h` - P+N+E 9H\n* `iec-60309-2p-e-4h` - 2P+E 4H\n* `iec-60309-2p-e-6h` - 2P+E 6H\n* `iec-60309-2p-e-9h` - 2P+E 9H\n* `iec-60309-3p-e-4h` - 3P+E 4H\n* `iec-60309-3p-e-6h` - 3P+E 6H\n* `iec-60309-3p-e-9h` - 3P+E 9H\n* `iec-60309-3p-n-e-4h` - 3P+N+E 4H\n* `iec-60309-3p-n-e-6h` - 3P+N+E 6H\n* `iec-60309-3p-n-e-9h` - 3P+N+E 9H\n* `iec-60906-1` - IEC 60906-1\n* `nbr-14136-10a` - 2P+T 10A (NBR 14136)\n* `nbr-14136-20a` - 2P+T 20A (NBR 14136)\n* `nema-1-15p` - NEMA 1-15P\n* `nema-5-15p` - NEMA 5-15P\n* `nema-5-20p` - NEMA 5-20P\n* `nema-5-30p` - NEMA 5-30P\n* `nema-5-50p` - NEMA 5-50P\n* `nema-6-15p` - NEMA 6-15P\n* `nema-6-20p` - NEMA 6-20P\n* `nema-6-30p` - NEMA 6-30P\n* `nema-6-50p` - NEMA 6-50P\n* `nema-10-30p` - NEMA 10-30P\n* `nema-10-50p` - NEMA 10-50P\n* `nema-14-20p` - NEMA 14-20P\n* `nema-14-30p` - NEMA 14-30P\n* `nema-14-50p` - NEMA 14-50P\n* `nema-14-60p` - NEMA 14-60P\n* `nema-15-15p` - NEMA 15-15P\n* `nema-15-20p` - NEMA 15-20P\n* `nema-15-30p` - NEMA 15-30P\n* `nema-15-50p` - NEMA 15-50P\n* `nema-15-60p` - NEMA 15-60P\n* `nema-l1-15p` - NEMA L1-15P\n* `nema-l5-15p` - NEMA L5-15P\n* `nema-l5-20p` - NEMA L5-20P\n* `nema-l5-30p` - NEMA L5-30P\n* `nema-l5-50p` - NEMA L5-50P\n* `nema-l6-15p` - NEMA L6-15P\n* `nema-l6-20p` - NEMA L6-20P\n* `nema-l6-30p` - NEMA L6-30P\n* `nema-l6-50p` - NEMA L6-50P\n* `nema-l10-30p` - NEMA L10-30P\n* `nema-l14-20p` - NEMA L14-20P\n* `nema-l14-30p` - NEMA L14-30P\n* `nema-l14-50p` - NEMA L14-50P\n* `nema-l14-60p` - NEMA L14-60P\n* `nema-l15-20p` - NEMA L15-20P\n* `nema-l15-30p` - NEMA L15-30P\n* `nema-l15-50p` - NEMA L15-50P\n* `nema-l15-60p` - NEMA L15-60P\n* `nema-l21-20p` - NEMA L21-20P\n* `nema-l21-30p` - NEMA L21-30P\n* `nema-l22-20p` - NEMA L22-20P\n* `nema-l22-30p` - NEMA L22-30P\n* `cs6361c` - CS6361C\n* `cs6365c` - CS6365C\n* `cs8165c` - CS8165C\n* `cs8265c` - CS8265C\n* `cs8365c` - CS8365C\n* `cs8465c` - CS8465C\n* `ita-c` - ITA Type C (CEE 7/16)\n* `ita-e` - ITA Type E (CEE 7/6)\n* `ita-f` - ITA Type F (CEE 7/4)\n* `ita-ef` - ITA Type E/F (CEE 7/7)\n* `ita-g` - ITA Type G (BS 1363)\n* `ita-h` - ITA Type H\n* `ita-i` - ITA Type I\n* `ita-j` - ITA Type J\n* `ita-k` - ITA Type K\n* `ita-l` - ITA Type L (CEI 23-50)\n* `ita-m` - ITA Type M (BS 546)\n* `ita-n` - ITA Type N\n* `ita-o` - ITA Type O\n* `usb-a` - USB Type A\n* `usb-b` - USB Type B\n* `usb-c` - USB Type C\n* `usb-mini-a` - USB Mini A\n* `usb-mini-b` - USB Mini B\n* `usb-micro-a` - USB Micro A\n* `usb-micro-b` - USB Micro B\n* `usb-micro-ab` - USB Micro AB\n* `usb-3-b` - USB 3.0 Type B\n* `usb-3-micro-b` - USB 3.0 Micro B\n* `molex-micro-fit-1x2` - Molex Micro-Fit 1x2\n* `molex-micro-fit-2x2` - Molex Micro-Fit 2x2\n* `molex-micro-fit-2x4` - Molex Micro-Fit 2x4\n* `dc-terminal` - DC Terminal\n* `saf-d-grid` - Saf-D-Grid\n* `neutrik-powercon-20` - Neutrik powerCON (20A)\n* `neutrik-powercon-32` - Neutrik powerCON (32A)\n* `neutrik-powercon-true1` - Neutrik powerCON TRUE1\n* `neutrik-powercon-true1-top` - Neutrik powerCON TRUE1 TOP\n* `ubiquiti-smartpower` - Ubiquiti SmartPower\n* `hardwired` - Hardwired\n* `other` - Other",
"x-spec-enum-id": "292850be2c08f7df",
"nullable": true
},
"maximum_draw": {
"type": "integer",
"maximum": 2147483647,
"minimum": 1,
"nullable": true,
"description": "Maximum power draw (watts)"
},
"allocated_draw": {
"type": "integer",
"maximum": 2147483647,
"minimum": 1,
"nullable": true,
"description": "Allocated power draw (watts)"
},
"description": {
"type": "string",
"maxLength": 200
}
}
},
"PatchedWritablePrefixRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"prefix": {
"type": "string",
"minLength": 1
},
"vrf": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefVRFRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"scope_type": {
"type": "string",
"nullable": true
},
"scope_id": {
"type": "integer",
"nullable": true
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"vlan": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefVLANRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"status": {
"enum": [
"container",
"active",
"reserved",
"deprecated"
],
"type": "string",
"x-spec-enum-id": "d38bee5f512701d9",
"description": "Operational status of this prefix\n\n* `container` - Container\n* `active` - Active\n* `reserved` - Reserved\n* `deprecated` - Deprecated"
},
"role": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefRoleRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"is_pool": {
"type": "boolean",
"title": "Is a pool",
"description": "All IP addresses within this prefix are considered usable"
},
"mark_utilized": {
"type": "boolean",
"description": "Treat as fully utilized"
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedWritableRackRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"facility_id": {
"type": "string",
"nullable": true,
"maxLength": 50
},
"site": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefSiteRequest"
}
]
},
"location": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefLocationRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"status": {
"enum": [
"reserved",
"available",
"planned",
"active",
"deprecated"
],
"type": "string",
"description": "* `reserved` - Reserved\n* `available` - Available\n* `planned` - Planned\n* `active` - Active\n* `deprecated` - Deprecated",
"x-spec-enum-id": "0c556d55dc1baa13"
},
"role": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefRackRoleRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"serial": {
"type": "string",
"title": "Serial number",
"maxLength": 50
},
"asset_tag": {
"type": "string",
"nullable": true,
"description": "A unique tag used to identify this rack",
"maxLength": 50
},
"rack_type": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefRackTypeRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"form_factor": {
"enum": [
"2-post-frame",
"4-post-frame",
"4-post-cabinet",
"wall-frame",
"wall-frame-vertical",
"wall-cabinet",
"wall-cabinet-vertical",
"",
null
],
"type": "string",
"description": "* `2-post-frame` - 2-post frame\n* `4-post-frame` - 4-post frame\n* `4-post-cabinet` - 4-post cabinet\n* `wall-frame` - Wall-mounted frame\n* `wall-frame-vertical` - Wall-mounted frame (vertical)\n* `wall-cabinet` - Wall-mounted cabinet\n* `wall-cabinet-vertical` - Wall-mounted cabinet (vertical)",
"x-spec-enum-id": "e32aaa89a223f2ea",
"nullable": true
},
"width": {
"enum": [
10,
19,
21,
23
],
"type": "integer",
"x-spec-enum-id": "9b322795f297a9c3",
"description": "Rail-to-rail width\n\n* `10` - 10 inches\n* `19` - 19 inches\n* `21` - 21 inches\n* `23` - 23 inches",
"minimum": 0,
"maximum": 32767
},
"u_height": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"title": "Height (U)",
"description": "Height in rack units"
},
"starting_unit": {
"type": "integer",
"maximum": 32767,
"minimum": 1,
"description": "Starting unit for rack"
},
"weight": {
"type": "number",
"format": "double",
"maximum": 1000000,
"minimum": -1000000,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true
},
"max_weight": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"description": "Maximum load capacity for the rack"
},
"weight_unit": {
"enum": [
"kg",
"g",
"lb",
"oz",
"",
null
],
"type": "string",
"description": "* `kg` - Kilograms\n* `g` - Grams\n* `lb` - Pounds\n* `oz` - Ounces",
"x-spec-enum-id": "7c1876f422815884",
"nullable": true
},
"desc_units": {
"type": "boolean",
"title": "Descending units",
"description": "Units are numbered top-to-bottom"
},
"outer_width": {
"type": "integer",
"maximum": 32767,
"minimum": 0,
"nullable": true,
"description": "Outer dimension of rack (width)"
},
"outer_height": {
"type": "integer",
"maximum": 32767,
"minimum": 0,
"nullable": true,
"description": "Outer dimension of rack (height)"
},
"outer_depth": {
"type": "integer",
"maximum": 32767,
"minimum": 0,
"nullable": true,
"description": "Outer dimension of rack (depth)"
},
"outer_unit": {
"enum": [
"mm",
"in",
"",
null
],
"type": "string",
"description": "* `mm` - Millimeters\n* `in` - Inches",
"x-spec-enum-id": "86a846b6c40f495e",
"nullable": true
},
"mounting_depth": {
"type": "integer",
"maximum": 32767,
"minimum": 0,
"nullable": true,
"description": "Maximum depth of a mounted device, in millimeters. For four-post racks, this is the distance between the front and rear rails."
},
"airflow": {
"enum": [
"front-to-rear",
"rear-to-front",
"",
null
],
"type": "string",
"description": "* `front-to-rear` - Front to rear\n* `rear-to-front` - Rear to front",
"x-spec-enum-id": "a784734d07ef1b3c",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedWritableRackReservationRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"rack": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefRackRequest"
}
]
},
"units": {
"type": "array",
"items": {
"type": "integer",
"maximum": 32767,
"minimum": 0
}
},
"status": {
"enum": [
"pending",
"active",
"stale"
],
"type": "string",
"description": "* `pending` - Pending\n* `active` - Active\n* `stale` - Stale",
"x-spec-enum-id": "b62013475549e423"
},
"user": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefUserRequest"
}
]
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"description": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedWritableRackTypeRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"manufacturer": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefManufacturerRequest"
}
]
},
"model": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
},
"form_factor": {
"enum": [
"2-post-frame",
"4-post-frame",
"4-post-cabinet",
"wall-frame",
"wall-frame-vertical",
"wall-cabinet",
"wall-cabinet-vertical"
],
"type": "string",
"description": "* `2-post-frame` - 2-post frame\n* `4-post-frame` - 4-post frame\n* `4-post-cabinet` - 4-post cabinet\n* `wall-frame` - Wall-mounted frame\n* `wall-frame-vertical` - Wall-mounted frame (vertical)\n* `wall-cabinet` - Wall-mounted cabinet\n* `wall-cabinet-vertical` - Wall-mounted cabinet (vertical)",
"x-spec-enum-id": "e32aaa89a223f2ea"
},
"width": {
"enum": [
10,
19,
21,
23
],
"type": "integer",
"x-spec-enum-id": "9b322795f297a9c3",
"description": "Rail-to-rail width\n\n* `10` - 10 inches\n* `19` - 19 inches\n* `21` - 21 inches\n* `23` - 23 inches",
"minimum": 0,
"maximum": 32767
},
"u_height": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"title": "Height (U)",
"description": "Height in rack units"
},
"starting_unit": {
"type": "integer",
"maximum": 32767,
"minimum": 1,
"description": "Starting unit for rack"
},
"desc_units": {
"type": "boolean",
"title": "Descending units",
"description": "Units are numbered top-to-bottom"
},
"outer_width": {
"type": "integer",
"maximum": 32767,
"minimum": 0,
"nullable": true,
"description": "Outer dimension of rack (width)"
},
"outer_height": {
"type": "integer",
"maximum": 32767,
"minimum": 0,
"nullable": true,
"description": "Outer dimension of rack (height)"
},
"outer_depth": {
"type": "integer",
"maximum": 32767,
"minimum": 0,
"nullable": true,
"description": "Outer dimension of rack (depth)"
},
"outer_unit": {
"enum": [
"mm",
"in",
"",
null
],
"type": "string",
"description": "* `mm` - Millimeters\n* `in` - Inches",
"x-spec-enum-id": "86a846b6c40f495e",
"nullable": true
},
"weight": {
"type": "number",
"format": "double",
"maximum": 1000000,
"minimum": -1000000,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true
},
"max_weight": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"description": "Maximum load capacity for the rack"
},
"weight_unit": {
"enum": [
"kg",
"g",
"lb",
"oz",
"",
null
],
"type": "string",
"description": "* `kg` - Kilograms\n* `g` - Grams\n* `lb` - Pounds\n* `oz` - Ounces",
"x-spec-enum-id": "7c1876f422815884",
"nullable": true
},
"mounting_depth": {
"type": "integer",
"maximum": 32767,
"minimum": 0,
"nullable": true,
"description": "Maximum depth of a mounted device, in millimeters. For four-post racks, this is the distance between the front and rear rails."
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedWritableRearPortRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"device": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDeviceRequest"
}
]
},
"module": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"enum": [
"8p8c",
"8p6c",
"8p4c",
"8p2c",
"6p6c",
"6p4c",
"6p2c",
"4p4c",
"4p2c",
"gg45",
"tera-4p",
"tera-2p",
"tera-1p",
"110-punch",
"bnc",
"f",
"n",
"mrj21",
"fc",
"fc-pc",
"fc-upc",
"fc-apc",
"lc",
"lc-pc",
"lc-upc",
"lc-apc",
"lsh",
"lsh-pc",
"lsh-upc",
"lsh-apc",
"lx5",
"lx5-pc",
"lx5-upc",
"lx5-apc",
"mpo",
"mtrj",
"sc",
"sc-pc",
"sc-upc",
"sc-apc",
"st",
"cs",
"sn",
"sma-905",
"sma-906",
"urm-p2",
"urm-p4",
"urm-p8",
"splice",
"usb-a",
"usb-b",
"usb-c",
"usb-mini-a",
"usb-mini-b",
"usb-micro-a",
"usb-micro-b",
"usb-micro-ab",
"other"
],
"type": "string",
"description": "* `8p8c` - 8P8C\n* `8p6c` - 8P6C\n* `8p4c` - 8P4C\n* `8p2c` - 8P2C\n* `6p6c` - 6P6C\n* `6p4c` - 6P4C\n* `6p2c` - 6P2C\n* `4p4c` - 4P4C\n* `4p2c` - 4P2C\n* `gg45` - GG45\n* `tera-4p` - TERA 4P\n* `tera-2p` - TERA 2P\n* `tera-1p` - TERA 1P\n* `110-punch` - 110 Punch\n* `bnc` - BNC\n* `f` - F Connector\n* `n` - N Connector\n* `mrj21` - MRJ21\n* `fc` - FC\n* `fc-pc` - FC/PC\n* `fc-upc` - FC/UPC\n* `fc-apc` - FC/APC\n* `lc` - LC\n* `lc-pc` - LC/PC\n* `lc-upc` - LC/UPC\n* `lc-apc` - LC/APC\n* `lsh` - LSH\n* `lsh-pc` - LSH/PC\n* `lsh-upc` - LSH/UPC\n* `lsh-apc` - LSH/APC\n* `lx5` - LX.5\n* `lx5-pc` - LX.5/PC\n* `lx5-upc` - LX.5/UPC\n* `lx5-apc` - LX.5/APC\n* `mpo` - MPO\n* `mtrj` - MTRJ\n* `sc` - SC\n* `sc-pc` - SC/PC\n* `sc-upc` - SC/UPC\n* `sc-apc` - SC/APC\n* `st` - ST\n* `cs` - CS\n* `sn` - SN\n* `sma-905` - SMA 905\n* `sma-906` - SMA 906\n* `urm-p2` - URM-P2\n* `urm-p4` - URM-P4\n* `urm-p8` - URM-P8\n* `splice` - Splice\n* `usb-a` - USB Type A\n* `usb-b` - USB Type B\n* `usb-c` - USB Type C\n* `usb-mini-a` - USB Mini A\n* `usb-mini-b` - USB Mini B\n* `usb-micro-a` - USB Micro A\n* `usb-micro-b` - USB Micro B\n* `usb-micro-ab` - USB Micro AB\n* `other` - Other",
"x-spec-enum-id": "ea67ae8ba4602f8a"
},
"color": {
"type": "string",
"pattern": "^[0-9a-f]{6}$",
"maxLength": 6
},
"positions": {
"type": "integer",
"maximum": 1024,
"minimum": 1,
"description": "Number of front ports which may be mapped"
},
"description": {
"type": "string",
"maxLength": 200
},
"mark_connected": {
"type": "boolean",
"description": "Treat as if a cable is connected"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedWritableRearPortTemplateRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"device_type": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefDeviceTypeRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"module_type": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleTypeRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"description": "{module} is accepted as a substitution for the module bay position when attached to a module type.",
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"enum": [
"8p8c",
"8p6c",
"8p4c",
"8p2c",
"6p6c",
"6p4c",
"6p2c",
"4p4c",
"4p2c",
"gg45",
"tera-4p",
"tera-2p",
"tera-1p",
"110-punch",
"bnc",
"f",
"n",
"mrj21",
"fc",
"fc-pc",
"fc-upc",
"fc-apc",
"lc",
"lc-pc",
"lc-upc",
"lc-apc",
"lsh",
"lsh-pc",
"lsh-upc",
"lsh-apc",
"lx5",
"lx5-pc",
"lx5-upc",
"lx5-apc",
"mpo",
"mtrj",
"sc",
"sc-pc",
"sc-upc",
"sc-apc",
"st",
"cs",
"sn",
"sma-905",
"sma-906",
"urm-p2",
"urm-p4",
"urm-p8",
"splice",
"usb-a",
"usb-b",
"usb-c",
"usb-mini-a",
"usb-mini-b",
"usb-micro-a",
"usb-micro-b",
"usb-micro-ab",
"other"
],
"type": "string",
"description": "* `8p8c` - 8P8C\n* `8p6c` - 8P6C\n* `8p4c` - 8P4C\n* `8p2c` - 8P2C\n* `6p6c` - 6P6C\n* `6p4c` - 6P4C\n* `6p2c` - 6P2C\n* `4p4c` - 4P4C\n* `4p2c` - 4P2C\n* `gg45` - GG45\n* `tera-4p` - TERA 4P\n* `tera-2p` - TERA 2P\n* `tera-1p` - TERA 1P\n* `110-punch` - 110 Punch\n* `bnc` - BNC\n* `f` - F Connector\n* `n` - N Connector\n* `mrj21` - MRJ21\n* `fc` - FC\n* `fc-pc` - FC/PC\n* `fc-upc` - FC/UPC\n* `fc-apc` - FC/APC\n* `lc` - LC\n* `lc-pc` - LC/PC\n* `lc-upc` - LC/UPC\n* `lc-apc` - LC/APC\n* `lsh` - LSH\n* `lsh-pc` - LSH/PC\n* `lsh-upc` - LSH/UPC\n* `lsh-apc` - LSH/APC\n* `lx5` - LX.5\n* `lx5-pc` - LX.5/PC\n* `lx5-upc` - LX.5/UPC\n* `lx5-apc` - LX.5/APC\n* `mpo` - MPO\n* `mtrj` - MTRJ\n* `sc` - SC\n* `sc-pc` - SC/PC\n* `sc-upc` - SC/UPC\n* `sc-apc` - SC/APC\n* `st` - ST\n* `cs` - CS\n* `sn` - SN\n* `sma-905` - SMA 905\n* `sma-906` - SMA 906\n* `urm-p2` - URM-P2\n* `urm-p4` - URM-P4\n* `urm-p8` - URM-P8\n* `splice` - Splice\n* `usb-a` - USB Type A\n* `usb-b` - USB Type B\n* `usb-c` - USB Type C\n* `usb-mini-a` - USB Mini A\n* `usb-mini-b` - USB Mini B\n* `usb-micro-a` - USB Micro A\n* `usb-micro-b` - USB Micro B\n* `usb-micro-ab` - USB Micro AB\n* `other` - Other",
"x-spec-enum-id": "ea67ae8ba4602f8a"
},
"color": {
"type": "string",
"pattern": "^[0-9a-f]{6}$",
"maxLength": 6
},
"positions": {
"type": "integer",
"maximum": 1024,
"minimum": 1
},
"description": {
"type": "string",
"maxLength": 200
}
}
},
"PatchedWritableRegionRequest": {
"type": "object",
"description": "Extends PrimaryModelSerializer to include MPTT support.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"parent": {
"type": "integer",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"comments": {
"type": "string"
}
}
},
"PatchedWritableServiceRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"parent_object_type": {
"type": "string"
},
"parent_object_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"protocol": {
"enum": [
"tcp",
"udp",
"sctp"
],
"type": "string",
"description": "* `tcp` - TCP\n* `udp` - UDP\n* `sctp` - SCTP",
"x-spec-enum-id": "5521e084b1ad51de"
},
"ports": {
"type": "array",
"items": {
"type": "integer",
"maximum": 65535,
"minimum": 1
},
"title": "Port numbers"
},
"ipaddresses": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedWritableServiceTemplateRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"protocol": {
"enum": [
"tcp",
"udp",
"sctp"
],
"type": "string",
"description": "* `tcp` - TCP\n* `udp` - UDP\n* `sctp` - SCTP",
"x-spec-enum-id": "5521e084b1ad51de"
},
"ports": {
"type": "array",
"items": {
"type": "integer",
"maximum": 65535,
"minimum": 1
},
"title": "Port numbers"
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedWritableSiteGroupRequest": {
"type": "object",
"description": "Extends PrimaryModelSerializer to include MPTT support.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"parent": {
"type": "integer",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"comments": {
"type": "string"
}
}
},
"PatchedWritableSiteRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"description": "Full name of the site",
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"status": {
"enum": [
"planned",
"staging",
"active",
"decommissioning",
"retired"
],
"type": "string",
"description": "* `planned` - Planned\n* `staging` - Staging\n* `active` - Active\n* `decommissioning` - Decommissioning\n* `retired` - Retired",
"x-spec-enum-id": "e363a8ddb138be50"
},
"region": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefRegionRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"group": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefSiteGroupRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"facility": {
"type": "string",
"description": "Local facility ID or description",
"maxLength": 50
},
"time_zone": {
"type": "string",
"nullable": true,
"minLength": 1
},
"description": {
"type": "string",
"maxLength": 200
},
"physical_address": {
"type": "string",
"description": "Physical location of the building",
"maxLength": 200
},
"shipping_address": {
"type": "string",
"description": "If different from the physical address",
"maxLength": 200
},
"latitude": {
"type": "number",
"format": "double",
"maximum": 100,
"minimum": -100,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true,
"description": "GPS coordinate in decimal format (xx.yyyyyy)"
},
"longitude": {
"type": "number",
"format": "double",
"maximum": 1000,
"minimum": -1000,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true,
"description": "GPS coordinate in decimal format (xx.yyyyyy)"
},
"comments": {
"type": "string"
},
"asns": {
"type": "array",
"items": {
"type": "integer"
}
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedWritableTenantGroupRequest": {
"type": "object",
"description": "Extends PrimaryModelSerializer to include MPTT support.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"parent": {
"type": "integer",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"comments": {
"type": "string"
}
}
},
"PatchedWritableTunnelRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"status": {
"enum": [
"planned",
"active",
"disabled"
],
"type": "string",
"description": "* `planned` - Planned\n* `active` - Active\n* `disabled` - Disabled",
"x-spec-enum-id": "0d65f7912cba74aa"
},
"group": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTunnelGroupRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"encapsulation": {
"enum": [
"ipsec-transport",
"ipsec-tunnel",
"ip-ip",
"gre",
"wireguard",
"openvpn",
"l2tp",
"pptp"
],
"type": "string",
"description": "* `ipsec-transport` - IPsec - Transport\n* `ipsec-tunnel` - IPsec - Tunnel\n* `ip-ip` - IP-in-IP\n* `gre` - GRE\n* `wireguard` - WireGuard\n* `openvpn` - OpenVPN\n* `l2tp` - L2TP\n* `pptp` - PPTP",
"x-spec-enum-id": "54a2e45824009c49"
},
"ipsec_profile": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefIPSecProfileRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"tunnel_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedWritableTunnelTerminationRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"tunnel": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefTunnelRequest"
}
]
},
"role": {
"enum": [
"peer",
"hub",
"spoke"
],
"type": "string",
"description": "* `peer` - Peer\n* `hub` - Hub\n* `spoke` - Spoke",
"x-spec-enum-id": "52225cd60b867572"
},
"termination_type": {
"type": "string"
},
"termination_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64",
"nullable": true
},
"outside_ip": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefIPAddressRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedWritableVLANRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"site": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefSiteRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"group": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefVLANGroupRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"vid": {
"type": "integer",
"maximum": 4094,
"minimum": 1,
"title": "VLAN ID",
"description": "Numeric VLAN ID (1-4094)"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"status": {
"enum": [
"active",
"reserved",
"deprecated"
],
"type": "string",
"x-spec-enum-id": "6388dfb94ca1cc15",
"description": "Operational status of this VLAN\n\n* `active` - Active\n* `reserved` - Reserved\n* `deprecated` - Deprecated"
},
"role": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefRoleRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"qinq_role": {
"enum": [
"svlan",
"cvlan",
"",
null
],
"type": "string",
"x-spec-enum-id": "d2510f2d3e3d3fb1",
"nullable": true,
"title": "Q-in-Q role",
"description": "Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad)\n\n* `svlan` - Service\n* `cvlan` - Customer"
},
"qinq_svlan": {
"type": "integer",
"nullable": true
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedWritableVMInterfaceRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"virtual_machine": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefVirtualMachineRequest"
}
]
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"enabled": {
"type": "boolean"
},
"parent": {
"type": "integer",
"nullable": true,
"title": "Parent interface"
},
"bridge": {
"type": "integer",
"nullable": true,
"title": "Bridge interface"
},
"mtu": {
"type": "integer",
"maximum": 65536,
"minimum": 1,
"nullable": true
},
"primary_mac_address": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefMACAddressRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"mode": {
"enum": [
"access",
"tagged",
"tagged-all",
"q-in-q",
"",
null
],
"type": "string",
"x-spec-enum-id": "b6fe48fe21dbf01d",
"nullable": true,
"description": "IEEE 802.1Q tagging strategy\n\n* `access` - Access\n* `tagged` - Tagged\n* `tagged-all` - Tagged (All)\n* `q-in-q` - Q-in-Q (802.1ad)"
},
"untagged_vlan": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefVLANRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"tagged_vlans": {
"type": "array",
"items": {
"type": "integer"
}
},
"qinq_svlan": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefVLANRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"vlan_translation_policy": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefVLANTranslationPolicyRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"vrf": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefVRFRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedWritableVirtualChassisRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"domain": {
"type": "string",
"maxLength": 30
},
"master": {
"type": "integer",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedWritableVirtualCircuitRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"cid": {
"type": "string",
"minLength": 1,
"title": "Circuit ID",
"description": "Unique circuit ID",
"maxLength": 100
},
"provider_network": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefProviderNetworkRequest"
}
]
},
"provider_account": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefProviderAccountRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"type": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefVirtualCircuitTypeRequest"
}
]
},
"status": {
"enum": [
"planned",
"provisioning",
"active",
"offline",
"deprovisioning",
"decommissioned"
],
"type": "string",
"description": "* `planned` - Planned\n* `provisioning` - Provisioning\n* `active` - Active\n* `offline` - Offline\n* `deprovisioning` - Deprovisioning\n* `decommissioned` - Decommissioned",
"x-spec-enum-id": "63c838134a022200"
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedWritableVirtualCircuitTerminationRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"virtual_circuit": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefVirtualCircuitRequest"
}
]
},
"role": {
"enum": [
"peer",
"hub",
"spoke"
],
"type": "string",
"description": "* `peer` - Peer\n* `hub` - Hub\n* `spoke` - Spoke",
"x-spec-enum-id": "52225cd60b867572"
},
"interface": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefInterfaceRequest"
}
]
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedWritableVirtualDeviceContextRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"device": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDeviceRequest"
}
]
},
"identifier": {
"type": "integer",
"maximum": 32767,
"minimum": 0,
"nullable": true
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"primary_ip4": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefIPAddressRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"primary_ip6": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefIPAddressRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"status": {
"enum": [
"active",
"planned",
"offline"
],
"type": "string",
"description": "* `active` - Active\n* `planned` - Planned\n* `offline` - Offline",
"x-spec-enum-id": "ee1ef02def7a91ab"
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedWritableVirtualMachineWithConfigContextRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"status": {
"enum": [
"offline",
"active",
"planned",
"staged",
"failed",
"decommissioning",
"paused"
],
"type": "string",
"description": "* `offline` - Offline\n* `active` - Active\n* `planned` - Planned\n* `staged` - Staged\n* `failed` - Failed\n* `decommissioning` - Decommissioning\n* `paused` - Paused",
"x-spec-enum-id": "c649dc8de233760f"
},
"site": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefSiteRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"cluster": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefClusterRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"device": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefDeviceRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"serial": {
"type": "string",
"title": "Serial number",
"maxLength": 50
},
"role": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefDeviceRoleRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"platform": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefPlatformRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"primary_ip4": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefIPAddressRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"primary_ip6": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefIPAddressRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"vcpus": {
"type": "number",
"format": "double",
"maximum": 10000,
"minimum": 0.01,
"exclusiveMaximum": true,
"nullable": true
},
"memory": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"title": "Memory (MB)"
},
"disk": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"title": "Disk (MB)"
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"config_template": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefConfigTemplateRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"local_context_data": {
"nullable": true,
"description": "Local config context data takes precedence over source contexts in the final rendered config context"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedWritableWirelessLANGroupRequest": {
"type": "object",
"description": "Extends PrimaryModelSerializer to include MPTT support.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"parent": {
"type": "integer",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"comments": {
"type": "string"
}
}
},
"PatchedWritableWirelessLANRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"ssid": {
"type": "string",
"minLength": 1,
"maxLength": 32
},
"description": {
"type": "string",
"maxLength": 200
},
"group": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefWirelessLANGroupRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"status": {
"enum": [
"active",
"reserved",
"disabled",
"deprecated"
],
"type": "string",
"description": "* `active` - Active\n* `reserved` - Reserved\n* `disabled` - Disabled\n* `deprecated` - Deprecated",
"x-spec-enum-id": "412ebdca597f609e"
},
"vlan": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefVLANRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"scope_type": {
"type": "string",
"nullable": true
},
"scope_id": {
"type": "integer",
"nullable": true
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"auth_type": {
"enum": [
"open",
"wep",
"wpa-personal",
"wpa-enterprise",
"",
null
],
"type": "string",
"description": "* `open` - Open\n* `wep` - WEP\n* `wpa-personal` - WPA Personal (PSK)\n* `wpa-enterprise` - WPA Enterprise",
"x-spec-enum-id": "a2043acb899b3954",
"nullable": true,
"title": "Authentication type"
},
"auth_cipher": {
"enum": [
"auto",
"tkip",
"aes",
"",
null
],
"type": "string",
"description": "* `auto` - Auto\n* `tkip` - TKIP\n* `aes` - AES",
"x-spec-enum-id": "8fdaefa727c26fdc",
"nullable": true,
"title": "Authentication cipher"
},
"auth_psk": {
"type": "string",
"title": "Pre-shared key",
"maxLength": 64
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"PatchedWritableWirelessLinkRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"interface_a": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefInterfaceRequest"
}
]
},
"interface_b": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefInterfaceRequest"
}
]
},
"ssid": {
"type": "string",
"maxLength": 32
},
"status": {
"enum": [
"connected",
"planned",
"decommissioning"
],
"type": "string",
"description": "* `connected` - Connected\n* `planned` - Planned\n* `decommissioning` - Decommissioning",
"x-spec-enum-id": "fbc2f302c08be50d"
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"auth_type": {
"enum": [
"open",
"wep",
"wpa-personal",
"wpa-enterprise",
"",
null
],
"type": "string",
"description": "* `open` - Open\n* `wep` - WEP\n* `wpa-personal` - WPA Personal (PSK)\n* `wpa-enterprise` - WPA Enterprise",
"x-spec-enum-id": "a2043acb899b3954",
"nullable": true,
"title": "Authentication type"
},
"auth_cipher": {
"enum": [
"auto",
"tkip",
"aes",
"",
null
],
"type": "string",
"description": "* `auto` - Auto\n* `tkip` - TKIP\n* `aes` - AES",
"x-spec-enum-id": "8fdaefa727c26fdc",
"nullable": true,
"title": "Authentication cipher"
},
"auth_psk": {
"type": "string",
"title": "Pre-shared key",
"maxLength": 64
},
"distance": {
"type": "number",
"format": "double",
"maximum": 1000000,
"minimum": -1000000,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true
},
"distance_unit": {
"enum": [
"km",
"m",
"mi",
"ft",
"",
null
],
"type": "string",
"description": "* `km` - Kilometers\n* `m` - Meters\n* `mi` - Miles\n* `ft` - Feet",
"x-spec-enum-id": "53542e7902f946af",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"Platform": {
"type": "object",
"description": "Extends PrimaryModelSerializer to include MPTT support.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"parent": {
"allOf": [
{
"$ref": "#/components/schemas/NestedPlatform"
}
],
"nullable": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"manufacturer": {
"allOf": [
{
"$ref": "#/components/schemas/BriefManufacturer"
}
],
"nullable": true
},
"config_template": {
"allOf": [
{
"$ref": "#/components/schemas/BriefConfigTemplate"
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"device_count": {
"type": "integer",
"readOnly": true,
"default": 0
},
"virtualmachine_count": {
"type": "integer",
"readOnly": true,
"default": 0
},
"_depth": {
"type": "integer",
"readOnly": true,
"title": " depth"
}
},
"required": [
"_depth",
"created",
"device_count",
"display",
"display_url",
"id",
"last_updated",
"name",
"slug",
"url",
"virtualmachine_count"
]
},
"PlatformRequest": {
"type": "object",
"description": "Extends PrimaryModelSerializer to include MPTT support.",
"properties": {
"parent": {
"allOf": [
{
"$ref": "#/components/schemas/NestedPlatformRequest"
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"manufacturer": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefManufacturerRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"config_template": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefConfigTemplateRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name",
"slug"
]
},
"PowerFeed": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"power_panel": {
"$ref": "#/components/schemas/BriefPowerPanel"
},
"rack": {
"allOf": [
{
"$ref": "#/components/schemas/BriefRack"
}
],
"nullable": true
},
"name": {
"type": "string",
"maxLength": 100
},
"status": {
"type": "object",
"properties": {
"value": {
"enum": [
"offline",
"active",
"planned",
"failed"
],
"type": "string",
"description": "* `offline` - Offline\n* `active` - Active\n* `planned` - Planned\n* `failed` - Failed",
"x-spec-enum-id": "b77fc919138c12f6"
},
"label": {
"type": "string",
"enum": [
"Offline",
"Active",
"Planned",
"Failed"
]
}
}
},
"type": {
"type": "object",
"properties": {
"value": {
"enum": [
"primary",
"redundant"
],
"type": "string",
"description": "* `primary` - Primary\n* `redundant` - Redundant",
"x-spec-enum-id": "093a164236819eb8"
},
"label": {
"type": "string",
"enum": [
"Primary",
"Redundant"
]
}
}
},
"supply": {
"type": "object",
"properties": {
"value": {
"enum": [
"ac",
"dc"
],
"type": "string",
"description": "* `ac` - AC\n* `dc` - DC",
"x-spec-enum-id": "1b6d99616ca6412b"
},
"label": {
"type": "string",
"enum": [
"AC",
"DC"
]
}
}
},
"phase": {
"type": "object",
"properties": {
"value": {
"enum": [
"single-phase",
"three-phase"
],
"type": "string",
"description": "* `single-phase` - Single phase\n* `three-phase` - Three-phase",
"x-spec-enum-id": "994bc0696f4df57f"
},
"label": {
"type": "string",
"enum": [
"Single phase",
"Three-phase"
]
}
}
},
"voltage": {
"type": "integer",
"maximum": 32767,
"minimum": -32768
},
"amperage": {
"type": "integer",
"maximum": 32767,
"minimum": 1
},
"max_utilization": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Maximum permissible draw (percentage)"
},
"mark_connected": {
"type": "boolean",
"description": "Treat as if a cable is connected"
},
"cable": {
"allOf": [
{
"$ref": "#/components/schemas/BriefCable"
}
],
"readOnly": true,
"nullable": true
},
"cable_end": {
"type": "string",
"readOnly": true
},
"link_peers": {
"type": "array",
"items": {},
"readOnly": true
},
"link_peers_type": {
"type": "string",
"description": "Return the type of the peer link terminations, or None.",
"readOnly": true,
"nullable": true
},
"connected_endpoints": {
"type": "array",
"items": {},
"nullable": true,
"readOnly": true
},
"connected_endpoints_type": {
"type": "string",
"readOnly": true,
"nullable": true
},
"connected_endpoints_reachable": {
"type": "boolean",
"readOnly": true
},
"description": {
"type": "string",
"maxLength": 200
},
"tenant": {
"allOf": [
{
"$ref": "#/components/schemas/BriefTenant"
}
],
"nullable": true
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"_occupied": {
"type": "boolean",
"readOnly": true,
"title": " occupied"
}
},
"required": [
"_occupied",
"cable",
"cable_end",
"connected_endpoints",
"connected_endpoints_reachable",
"connected_endpoints_type",
"created",
"display",
"display_url",
"id",
"last_updated",
"link_peers",
"link_peers_type",
"name",
"power_panel",
"url"
]
},
"PowerFeedRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"power_panel": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefPowerPanelRequest"
}
]
},
"rack": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefRackRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"status": {
"enum": [
"offline",
"active",
"planned",
"failed"
],
"type": "string",
"description": "* `offline` - Offline\n* `active` - Active\n* `planned` - Planned\n* `failed` - Failed",
"x-spec-enum-id": "b77fc919138c12f6"
},
"type": {
"enum": [
"primary",
"redundant"
],
"type": "string",
"description": "* `primary` - Primary\n* `redundant` - Redundant",
"x-spec-enum-id": "093a164236819eb8"
},
"supply": {
"enum": [
"ac",
"dc"
],
"type": "string",
"description": "* `ac` - AC\n* `dc` - DC",
"x-spec-enum-id": "1b6d99616ca6412b"
},
"phase": {
"enum": [
"single-phase",
"three-phase"
],
"type": "string",
"description": "* `single-phase` - Single phase\n* `three-phase` - Three-phase",
"x-spec-enum-id": "994bc0696f4df57f"
},
"voltage": {
"type": "integer",
"maximum": 32767,
"minimum": -32768
},
"amperage": {
"type": "integer",
"maximum": 32767,
"minimum": 1
},
"max_utilization": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Maximum permissible draw (percentage)"
},
"mark_connected": {
"type": "boolean",
"description": "Treat as if a cable is connected"
},
"description": {
"type": "string",
"maxLength": 200
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name",
"power_panel"
]
},
"PowerOutlet": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"device": {
"$ref": "#/components/schemas/BriefDevice"
},
"module": {
"allOf": [
{
"$ref": "#/components/schemas/BriefModule"
}
],
"nullable": true
},
"name": {
"type": "string",
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"type": "object",
"properties": {
"value": {
"enum": [
"iec-60320-c5",
"iec-60320-c7",
"iec-60320-c13",
"iec-60320-c15",
"iec-60320-c17",
"iec-60320-c19",
"iec-60320-c21",
"iec-60309-p-n-e-4h",
"iec-60309-p-n-e-6h",
"iec-60309-p-n-e-9h",
"iec-60309-2p-e-4h",
"iec-60309-2p-e-6h",
"iec-60309-2p-e-9h",
"iec-60309-3p-e-4h",
"iec-60309-3p-e-6h",
"iec-60309-3p-e-9h",
"iec-60309-3p-n-e-4h",
"iec-60309-3p-n-e-6h",
"iec-60309-3p-n-e-9h",
"iec-60906-1",
"nbr-14136-10a",
"nbr-14136-20a",
"nema-1-15r",
"nema-5-15r",
"nema-5-20r",
"nema-5-30r",
"nema-5-50r",
"nema-6-15r",
"nema-6-20r",
"nema-6-30r",
"nema-6-50r",
"nema-10-30r",
"nema-10-50r",
"nema-14-20r",
"nema-14-30r",
"nema-14-50r",
"nema-14-60r",
"nema-15-15r",
"nema-15-20r",
"nema-15-30r",
"nema-15-50r",
"nema-15-60r",
"nema-l1-15r",
"nema-l5-15r",
"nema-l5-20r",
"nema-l5-30r",
"nema-l5-50r",
"nema-l6-15r",
"nema-l6-20r",
"nema-l6-30r",
"nema-l6-50r",
"nema-l10-30r",
"nema-l14-20r",
"nema-l14-30r",
"nema-l14-50r",
"nema-l14-60r",
"nema-l15-20r",
"nema-l15-30r",
"nema-l15-50r",
"nema-l15-60r",
"nema-l21-20r",
"nema-l21-30r",
"nema-l22-20r",
"nema-l22-30r",
"CS6360C",
"CS6364C",
"CS8164C",
"CS8264C",
"CS8364C",
"CS8464C",
"ita-e",
"ita-f",
"ita-g",
"ita-h",
"ita-i",
"ita-j",
"ita-k",
"ita-l",
"ita-m",
"ita-n",
"ita-o",
"ita-multistandard",
"usb-a",
"usb-micro-b",
"usb-c",
"molex-micro-fit-1x2",
"molex-micro-fit-2x2",
"molex-micro-fit-2x4",
"dc-terminal",
"eaton-c39",
"hdot-cx",
"saf-d-grid",
"neutrik-powercon-20a",
"neutrik-powercon-32a",
"neutrik-powercon-true1",
"neutrik-powercon-true1-top",
"ubiquiti-smartpower",
"hardwired",
"other",
"",
null
],
"type": "string",
"description": "* `iec-60320-c5` - C5\n* `iec-60320-c7` - C7\n* `iec-60320-c13` - C13\n* `iec-60320-c15` - C15\n* `iec-60320-c17` - C17\n* `iec-60320-c19` - C19\n* `iec-60320-c21` - C21\n* `iec-60309-p-n-e-4h` - P+N+E 4H\n* `iec-60309-p-n-e-6h` - P+N+E 6H\n* `iec-60309-p-n-e-9h` - P+N+E 9H\n* `iec-60309-2p-e-4h` - 2P+E 4H\n* `iec-60309-2p-e-6h` - 2P+E 6H\n* `iec-60309-2p-e-9h` - 2P+E 9H\n* `iec-60309-3p-e-4h` - 3P+E 4H\n* `iec-60309-3p-e-6h` - 3P+E 6H\n* `iec-60309-3p-e-9h` - 3P+E 9H\n* `iec-60309-3p-n-e-4h` - 3P+N+E 4H\n* `iec-60309-3p-n-e-6h` - 3P+N+E 6H\n* `iec-60309-3p-n-e-9h` - 3P+N+E 9H\n* `iec-60906-1` - IEC 60906-1\n* `nbr-14136-10a` - 2P+T 10A (NBR 14136)\n* `nbr-14136-20a` - 2P+T 20A (NBR 14136)\n* `nema-1-15r` - NEMA 1-15R\n* `nema-5-15r` - NEMA 5-15R\n* `nema-5-20r` - NEMA 5-20R\n* `nema-5-30r` - NEMA 5-30R\n* `nema-5-50r` - NEMA 5-50R\n* `nema-6-15r` - NEMA 6-15R\n* `nema-6-20r` - NEMA 6-20R\n* `nema-6-30r` - NEMA 6-30R\n* `nema-6-50r` - NEMA 6-50R\n* `nema-10-30r` - NEMA 10-30R\n* `nema-10-50r` - NEMA 10-50R\n* `nema-14-20r` - NEMA 14-20R\n* `nema-14-30r` - NEMA 14-30R\n* `nema-14-50r` - NEMA 14-50R\n* `nema-14-60r` - NEMA 14-60R\n* `nema-15-15r` - NEMA 15-15R\n* `nema-15-20r` - NEMA 15-20R\n* `nema-15-30r` - NEMA 15-30R\n* `nema-15-50r` - NEMA 15-50R\n* `nema-15-60r` - NEMA 15-60R\n* `nema-l1-15r` - NEMA L1-15R\n* `nema-l5-15r` - NEMA L5-15R\n* `nema-l5-20r` - NEMA L5-20R\n* `nema-l5-30r` - NEMA L5-30R\n* `nema-l5-50r` - NEMA L5-50R\n* `nema-l6-15r` - NEMA L6-15R\n* `nema-l6-20r` - NEMA L6-20R\n* `nema-l6-30r` - NEMA L6-30R\n* `nema-l6-50r` - NEMA L6-50R\n* `nema-l10-30r` - NEMA L10-30R\n* `nema-l14-20r` - NEMA L14-20R\n* `nema-l14-30r` - NEMA L14-30R\n* `nema-l14-50r` - NEMA L14-50R\n* `nema-l14-60r` - NEMA L14-60R\n* `nema-l15-20r` - NEMA L15-20R\n* `nema-l15-30r` - NEMA L15-30R\n* `nema-l15-50r` - NEMA L15-50R\n* `nema-l15-60r` - NEMA L15-60R\n* `nema-l21-20r` - NEMA L21-20R\n* `nema-l21-30r` - NEMA L21-30R\n* `nema-l22-20r` - NEMA L22-20R\n* `nema-l22-30r` - NEMA L22-30R\n* `CS6360C` - CS6360C\n* `CS6364C` - CS6364C\n* `CS8164C` - CS8164C\n* `CS8264C` - CS8264C\n* `CS8364C` - CS8364C\n* `CS8464C` - CS8464C\n* `ita-e` - ITA Type E (CEE 7/5)\n* `ita-f` - ITA Type F (CEE 7/3)\n* `ita-g` - ITA Type G (BS 1363)\n* `ita-h` - ITA Type H\n* `ita-i` - ITA Type I\n* `ita-j` - ITA Type J\n* `ita-k` - ITA Type K\n* `ita-l` - ITA Type L (CEI 23-50)\n* `ita-m` - ITA Type M (BS 546)\n* `ita-n` - ITA Type N\n* `ita-o` - ITA Type O\n* `ita-multistandard` - ITA Multistandard\n* `usb-a` - USB Type A\n* `usb-micro-b` - USB Micro B\n* `usb-c` - USB Type C\n* `molex-micro-fit-1x2` - Molex Micro-Fit 1x2\n* `molex-micro-fit-2x2` - Molex Micro-Fit 2x2\n* `molex-micro-fit-2x4` - Molex Micro-Fit 2x4\n* `dc-terminal` - DC Terminal\n* `eaton-c39` - Eaton C39\n* `hdot-cx` - HDOT Cx\n* `saf-d-grid` - Saf-D-Grid\n* `neutrik-powercon-20a` - Neutrik powerCON (20A)\n* `neutrik-powercon-32a` - Neutrik powerCON (32A)\n* `neutrik-powercon-true1` - Neutrik powerCON TRUE1\n* `neutrik-powercon-true1-top` - Neutrik powerCON TRUE1 TOP\n* `ubiquiti-smartpower` - Ubiquiti SmartPower\n* `hardwired` - Hardwired\n* `other` - Other",
"x-spec-enum-id": "8f9617d2648ab261"
},
"label": {
"type": "string",
"enum": [
"C5",
"C7",
"C13",
"C15",
"C17",
"C19",
"C21",
"P+N+E 4H",
"P+N+E 6H",
"P+N+E 9H",
"2P+E 4H",
"2P+E 6H",
"2P+E 9H",
"3P+E 4H",
"3P+E 6H",
"3P+E 9H",
"3P+N+E 4H",
"3P+N+E 6H",
"3P+N+E 9H",
"IEC 60906-1",
"2P+T 10A (NBR 14136)",
"2P+T 20A (NBR 14136)",
"NEMA 1-15R",
"NEMA 5-15R",
"NEMA 5-20R",
"NEMA 5-30R",
"NEMA 5-50R",
"NEMA 6-15R",
"NEMA 6-20R",
"NEMA 6-30R",
"NEMA 6-50R",
"NEMA 10-30R",
"NEMA 10-50R",
"NEMA 14-20R",
"NEMA 14-30R",
"NEMA 14-50R",
"NEMA 14-60R",
"NEMA 15-15R",
"NEMA 15-20R",
"NEMA 15-30R",
"NEMA 15-50R",
"NEMA 15-60R",
"NEMA L1-15R",
"NEMA L5-15R",
"NEMA L5-20R",
"NEMA L5-30R",
"NEMA L5-50R",
"NEMA L6-15R",
"NEMA L6-20R",
"NEMA L6-30R",
"NEMA L6-50R",
"NEMA L10-30R",
"NEMA L14-20R",
"NEMA L14-30R",
"NEMA L14-50R",
"NEMA L14-60R",
"NEMA L15-20R",
"NEMA L15-30R",
"NEMA L15-50R",
"NEMA L15-60R",
"NEMA L21-20R",
"NEMA L21-30R",
"NEMA L22-20R",
"NEMA L22-30R",
"CS6360C",
"CS6364C",
"CS8164C",
"CS8264C",
"CS8364C",
"CS8464C",
"ITA Type E (CEE 7/5)",
"ITA Type F (CEE 7/3)",
"ITA Type G (BS 1363)",
"ITA Type H",
"ITA Type I",
"ITA Type J",
"ITA Type K",
"ITA Type L (CEI 23-50)",
"ITA Type M (BS 546)",
"ITA Type N",
"ITA Type O",
"ITA Multistandard",
"USB Type A",
"USB Micro B",
"USB Type C",
"Molex Micro-Fit 1x2",
"Molex Micro-Fit 2x2",
"Molex Micro-Fit 2x4",
"DC Terminal",
"Eaton C39",
"HDOT Cx",
"Saf-D-Grid",
"Neutrik powerCON (20A)",
"Neutrik powerCON (32A)",
"Neutrik powerCON TRUE1",
"Neutrik powerCON TRUE1 TOP",
"Ubiquiti SmartPower",
"Hardwired",
"Other"
]
}
},
"nullable": true
},
"status": {
"type": "object",
"properties": {
"value": {
"enum": [
"enabled",
"disabled",
"faulty"
],
"type": "string",
"description": "* `enabled` - Enabled\n* `disabled` - Disabled\n* `faulty` - Faulty",
"x-spec-enum-id": "1024f7deaed962d7"
},
"label": {
"type": "string",
"enum": [
"Enabled",
"Disabled",
"Faulty"
]
}
}
},
"color": {
"type": "string",
"pattern": "^[0-9a-f]{6}$",
"maxLength": 6
},
"power_port": {
"allOf": [
{
"$ref": "#/components/schemas/BriefPowerPort"
}
],
"nullable": true
},
"feed_leg": {
"type": "object",
"properties": {
"value": {
"enum": [
"A",
"B",
"C",
"",
null
],
"type": "string",
"description": "* `A` - A\n* `B` - B\n* `C` - C",
"x-spec-enum-id": "a4902339df0b7c06"
},
"label": {
"type": "string",
"enum": [
"A",
"B",
"C"
]
}
},
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"mark_connected": {
"type": "boolean",
"description": "Treat as if a cable is connected"
},
"cable": {
"allOf": [
{
"$ref": "#/components/schemas/BriefCable"
}
],
"readOnly": true,
"nullable": true
},
"cable_end": {
"type": "string",
"readOnly": true
},
"link_peers": {
"type": "array",
"items": {},
"readOnly": true
},
"link_peers_type": {
"type": "string",
"description": "Return the type of the peer link terminations, or None.",
"readOnly": true,
"nullable": true
},
"connected_endpoints": {
"type": "array",
"items": {},
"nullable": true,
"readOnly": true
},
"connected_endpoints_type": {
"type": "string",
"readOnly": true,
"nullable": true
},
"connected_endpoints_reachable": {
"type": "boolean",
"readOnly": true
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"_occupied": {
"type": "boolean",
"readOnly": true,
"title": " occupied"
}
},
"required": [
"_occupied",
"cable",
"cable_end",
"connected_endpoints",
"connected_endpoints_reachable",
"connected_endpoints_type",
"created",
"device",
"display",
"display_url",
"id",
"last_updated",
"link_peers",
"link_peers_type",
"name",
"url"
]
},
"PowerOutletRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"device": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDeviceRequest"
}
]
},
"module": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"enum": [
"iec-60320-c5",
"iec-60320-c7",
"iec-60320-c13",
"iec-60320-c15",
"iec-60320-c17",
"iec-60320-c19",
"iec-60320-c21",
"iec-60309-p-n-e-4h",
"iec-60309-p-n-e-6h",
"iec-60309-p-n-e-9h",
"iec-60309-2p-e-4h",
"iec-60309-2p-e-6h",
"iec-60309-2p-e-9h",
"iec-60309-3p-e-4h",
"iec-60309-3p-e-6h",
"iec-60309-3p-e-9h",
"iec-60309-3p-n-e-4h",
"iec-60309-3p-n-e-6h",
"iec-60309-3p-n-e-9h",
"iec-60906-1",
"nbr-14136-10a",
"nbr-14136-20a",
"nema-1-15r",
"nema-5-15r",
"nema-5-20r",
"nema-5-30r",
"nema-5-50r",
"nema-6-15r",
"nema-6-20r",
"nema-6-30r",
"nema-6-50r",
"nema-10-30r",
"nema-10-50r",
"nema-14-20r",
"nema-14-30r",
"nema-14-50r",
"nema-14-60r",
"nema-15-15r",
"nema-15-20r",
"nema-15-30r",
"nema-15-50r",
"nema-15-60r",
"nema-l1-15r",
"nema-l5-15r",
"nema-l5-20r",
"nema-l5-30r",
"nema-l5-50r",
"nema-l6-15r",
"nema-l6-20r",
"nema-l6-30r",
"nema-l6-50r",
"nema-l10-30r",
"nema-l14-20r",
"nema-l14-30r",
"nema-l14-50r",
"nema-l14-60r",
"nema-l15-20r",
"nema-l15-30r",
"nema-l15-50r",
"nema-l15-60r",
"nema-l21-20r",
"nema-l21-30r",
"nema-l22-20r",
"nema-l22-30r",
"CS6360C",
"CS6364C",
"CS8164C",
"CS8264C",
"CS8364C",
"CS8464C",
"ita-e",
"ita-f",
"ita-g",
"ita-h",
"ita-i",
"ita-j",
"ita-k",
"ita-l",
"ita-m",
"ita-n",
"ita-o",
"ita-multistandard",
"usb-a",
"usb-micro-b",
"usb-c",
"molex-micro-fit-1x2",
"molex-micro-fit-2x2",
"molex-micro-fit-2x4",
"dc-terminal",
"eaton-c39",
"hdot-cx",
"saf-d-grid",
"neutrik-powercon-20a",
"neutrik-powercon-32a",
"neutrik-powercon-true1",
"neutrik-powercon-true1-top",
"ubiquiti-smartpower",
"hardwired",
"other",
"",
null
],
"type": "string",
"description": "* `iec-60320-c5` - C5\n* `iec-60320-c7` - C7\n* `iec-60320-c13` - C13\n* `iec-60320-c15` - C15\n* `iec-60320-c17` - C17\n* `iec-60320-c19` - C19\n* `iec-60320-c21` - C21\n* `iec-60309-p-n-e-4h` - P+N+E 4H\n* `iec-60309-p-n-e-6h` - P+N+E 6H\n* `iec-60309-p-n-e-9h` - P+N+E 9H\n* `iec-60309-2p-e-4h` - 2P+E 4H\n* `iec-60309-2p-e-6h` - 2P+E 6H\n* `iec-60309-2p-e-9h` - 2P+E 9H\n* `iec-60309-3p-e-4h` - 3P+E 4H\n* `iec-60309-3p-e-6h` - 3P+E 6H\n* `iec-60309-3p-e-9h` - 3P+E 9H\n* `iec-60309-3p-n-e-4h` - 3P+N+E 4H\n* `iec-60309-3p-n-e-6h` - 3P+N+E 6H\n* `iec-60309-3p-n-e-9h` - 3P+N+E 9H\n* `iec-60906-1` - IEC 60906-1\n* `nbr-14136-10a` - 2P+T 10A (NBR 14136)\n* `nbr-14136-20a` - 2P+T 20A (NBR 14136)\n* `nema-1-15r` - NEMA 1-15R\n* `nema-5-15r` - NEMA 5-15R\n* `nema-5-20r` - NEMA 5-20R\n* `nema-5-30r` - NEMA 5-30R\n* `nema-5-50r` - NEMA 5-50R\n* `nema-6-15r` - NEMA 6-15R\n* `nema-6-20r` - NEMA 6-20R\n* `nema-6-30r` - NEMA 6-30R\n* `nema-6-50r` - NEMA 6-50R\n* `nema-10-30r` - NEMA 10-30R\n* `nema-10-50r` - NEMA 10-50R\n* `nema-14-20r` - NEMA 14-20R\n* `nema-14-30r` - NEMA 14-30R\n* `nema-14-50r` - NEMA 14-50R\n* `nema-14-60r` - NEMA 14-60R\n* `nema-15-15r` - NEMA 15-15R\n* `nema-15-20r` - NEMA 15-20R\n* `nema-15-30r` - NEMA 15-30R\n* `nema-15-50r` - NEMA 15-50R\n* `nema-15-60r` - NEMA 15-60R\n* `nema-l1-15r` - NEMA L1-15R\n* `nema-l5-15r` - NEMA L5-15R\n* `nema-l5-20r` - NEMA L5-20R\n* `nema-l5-30r` - NEMA L5-30R\n* `nema-l5-50r` - NEMA L5-50R\n* `nema-l6-15r` - NEMA L6-15R\n* `nema-l6-20r` - NEMA L6-20R\n* `nema-l6-30r` - NEMA L6-30R\n* `nema-l6-50r` - NEMA L6-50R\n* `nema-l10-30r` - NEMA L10-30R\n* `nema-l14-20r` - NEMA L14-20R\n* `nema-l14-30r` - NEMA L14-30R\n* `nema-l14-50r` - NEMA L14-50R\n* `nema-l14-60r` - NEMA L14-60R\n* `nema-l15-20r` - NEMA L15-20R\n* `nema-l15-30r` - NEMA L15-30R\n* `nema-l15-50r` - NEMA L15-50R\n* `nema-l15-60r` - NEMA L15-60R\n* `nema-l21-20r` - NEMA L21-20R\n* `nema-l21-30r` - NEMA L21-30R\n* `nema-l22-20r` - NEMA L22-20R\n* `nema-l22-30r` - NEMA L22-30R\n* `CS6360C` - CS6360C\n* `CS6364C` - CS6364C\n* `CS8164C` - CS8164C\n* `CS8264C` - CS8264C\n* `CS8364C` - CS8364C\n* `CS8464C` - CS8464C\n* `ita-e` - ITA Type E (CEE 7/5)\n* `ita-f` - ITA Type F (CEE 7/3)\n* `ita-g` - ITA Type G (BS 1363)\n* `ita-h` - ITA Type H\n* `ita-i` - ITA Type I\n* `ita-j` - ITA Type J\n* `ita-k` - ITA Type K\n* `ita-l` - ITA Type L (CEI 23-50)\n* `ita-m` - ITA Type M (BS 546)\n* `ita-n` - ITA Type N\n* `ita-o` - ITA Type O\n* `ita-multistandard` - ITA Multistandard\n* `usb-a` - USB Type A\n* `usb-micro-b` - USB Micro B\n* `usb-c` - USB Type C\n* `molex-micro-fit-1x2` - Molex Micro-Fit 1x2\n* `molex-micro-fit-2x2` - Molex Micro-Fit 2x2\n* `molex-micro-fit-2x4` - Molex Micro-Fit 2x4\n* `dc-terminal` - DC Terminal\n* `eaton-c39` - Eaton C39\n* `hdot-cx` - HDOT Cx\n* `saf-d-grid` - Saf-D-Grid\n* `neutrik-powercon-20a` - Neutrik powerCON (20A)\n* `neutrik-powercon-32a` - Neutrik powerCON (32A)\n* `neutrik-powercon-true1` - Neutrik powerCON TRUE1\n* `neutrik-powercon-true1-top` - Neutrik powerCON TRUE1 TOP\n* `ubiquiti-smartpower` - Ubiquiti SmartPower\n* `hardwired` - Hardwired\n* `other` - Other",
"x-spec-enum-id": "8f9617d2648ab261",
"nullable": true
},
"status": {
"enum": [
"enabled",
"disabled",
"faulty"
],
"type": "string",
"description": "* `enabled` - Enabled\n* `disabled` - Disabled\n* `faulty` - Faulty",
"x-spec-enum-id": "1024f7deaed962d7"
},
"color": {
"type": "string",
"pattern": "^[0-9a-f]{6}$",
"maxLength": 6
},
"power_port": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefPowerPortRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"feed_leg": {
"enum": [
"A",
"B",
"C",
"",
null
],
"type": "string",
"description": "* `A` - A\n* `B` - B\n* `C` - C",
"x-spec-enum-id": "a4902339df0b7c06",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"mark_connected": {
"type": "boolean",
"description": "Treat as if a cable is connected"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"device",
"name"
]
},
"PowerOutletTemplate": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"device_type": {
"allOf": [
{
"$ref": "#/components/schemas/BriefDeviceType"
}
],
"nullable": true
},
"module_type": {
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleType"
}
],
"nullable": true
},
"name": {
"type": "string",
"description": "{module} is accepted as a substitution for the module bay position when attached to a module type.",
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"type": "object",
"properties": {
"value": {
"enum": [
"iec-60320-c5",
"iec-60320-c7",
"iec-60320-c13",
"iec-60320-c15",
"iec-60320-c17",
"iec-60320-c19",
"iec-60320-c21",
"iec-60309-p-n-e-4h",
"iec-60309-p-n-e-6h",
"iec-60309-p-n-e-9h",
"iec-60309-2p-e-4h",
"iec-60309-2p-e-6h",
"iec-60309-2p-e-9h",
"iec-60309-3p-e-4h",
"iec-60309-3p-e-6h",
"iec-60309-3p-e-9h",
"iec-60309-3p-n-e-4h",
"iec-60309-3p-n-e-6h",
"iec-60309-3p-n-e-9h",
"iec-60906-1",
"nbr-14136-10a",
"nbr-14136-20a",
"nema-1-15r",
"nema-5-15r",
"nema-5-20r",
"nema-5-30r",
"nema-5-50r",
"nema-6-15r",
"nema-6-20r",
"nema-6-30r",
"nema-6-50r",
"nema-10-30r",
"nema-10-50r",
"nema-14-20r",
"nema-14-30r",
"nema-14-50r",
"nema-14-60r",
"nema-15-15r",
"nema-15-20r",
"nema-15-30r",
"nema-15-50r",
"nema-15-60r",
"nema-l1-15r",
"nema-l5-15r",
"nema-l5-20r",
"nema-l5-30r",
"nema-l5-50r",
"nema-l6-15r",
"nema-l6-20r",
"nema-l6-30r",
"nema-l6-50r",
"nema-l10-30r",
"nema-l14-20r",
"nema-l14-30r",
"nema-l14-50r",
"nema-l14-60r",
"nema-l15-20r",
"nema-l15-30r",
"nema-l15-50r",
"nema-l15-60r",
"nema-l21-20r",
"nema-l21-30r",
"nema-l22-20r",
"nema-l22-30r",
"CS6360C",
"CS6364C",
"CS8164C",
"CS8264C",
"CS8364C",
"CS8464C",
"ita-e",
"ita-f",
"ita-g",
"ita-h",
"ita-i",
"ita-j",
"ita-k",
"ita-l",
"ita-m",
"ita-n",
"ita-o",
"ita-multistandard",
"usb-a",
"usb-micro-b",
"usb-c",
"molex-micro-fit-1x2",
"molex-micro-fit-2x2",
"molex-micro-fit-2x4",
"dc-terminal",
"eaton-c39",
"hdot-cx",
"saf-d-grid",
"neutrik-powercon-20a",
"neutrik-powercon-32a",
"neutrik-powercon-true1",
"neutrik-powercon-true1-top",
"ubiquiti-smartpower",
"hardwired",
"other",
"",
null
],
"type": "string",
"description": "* `iec-60320-c5` - C5\n* `iec-60320-c7` - C7\n* `iec-60320-c13` - C13\n* `iec-60320-c15` - C15\n* `iec-60320-c17` - C17\n* `iec-60320-c19` - C19\n* `iec-60320-c21` - C21\n* `iec-60309-p-n-e-4h` - P+N+E 4H\n* `iec-60309-p-n-e-6h` - P+N+E 6H\n* `iec-60309-p-n-e-9h` - P+N+E 9H\n* `iec-60309-2p-e-4h` - 2P+E 4H\n* `iec-60309-2p-e-6h` - 2P+E 6H\n* `iec-60309-2p-e-9h` - 2P+E 9H\n* `iec-60309-3p-e-4h` - 3P+E 4H\n* `iec-60309-3p-e-6h` - 3P+E 6H\n* `iec-60309-3p-e-9h` - 3P+E 9H\n* `iec-60309-3p-n-e-4h` - 3P+N+E 4H\n* `iec-60309-3p-n-e-6h` - 3P+N+E 6H\n* `iec-60309-3p-n-e-9h` - 3P+N+E 9H\n* `iec-60906-1` - IEC 60906-1\n* `nbr-14136-10a` - 2P+T 10A (NBR 14136)\n* `nbr-14136-20a` - 2P+T 20A (NBR 14136)\n* `nema-1-15r` - NEMA 1-15R\n* `nema-5-15r` - NEMA 5-15R\n* `nema-5-20r` - NEMA 5-20R\n* `nema-5-30r` - NEMA 5-30R\n* `nema-5-50r` - NEMA 5-50R\n* `nema-6-15r` - NEMA 6-15R\n* `nema-6-20r` - NEMA 6-20R\n* `nema-6-30r` - NEMA 6-30R\n* `nema-6-50r` - NEMA 6-50R\n* `nema-10-30r` - NEMA 10-30R\n* `nema-10-50r` - NEMA 10-50R\n* `nema-14-20r` - NEMA 14-20R\n* `nema-14-30r` - NEMA 14-30R\n* `nema-14-50r` - NEMA 14-50R\n* `nema-14-60r` - NEMA 14-60R\n* `nema-15-15r` - NEMA 15-15R\n* `nema-15-20r` - NEMA 15-20R\n* `nema-15-30r` - NEMA 15-30R\n* `nema-15-50r` - NEMA 15-50R\n* `nema-15-60r` - NEMA 15-60R\n* `nema-l1-15r` - NEMA L1-15R\n* `nema-l5-15r` - NEMA L5-15R\n* `nema-l5-20r` - NEMA L5-20R\n* `nema-l5-30r` - NEMA L5-30R\n* `nema-l5-50r` - NEMA L5-50R\n* `nema-l6-15r` - NEMA L6-15R\n* `nema-l6-20r` - NEMA L6-20R\n* `nema-l6-30r` - NEMA L6-30R\n* `nema-l6-50r` - NEMA L6-50R\n* `nema-l10-30r` - NEMA L10-30R\n* `nema-l14-20r` - NEMA L14-20R\n* `nema-l14-30r` - NEMA L14-30R\n* `nema-l14-50r` - NEMA L14-50R\n* `nema-l14-60r` - NEMA L14-60R\n* `nema-l15-20r` - NEMA L15-20R\n* `nema-l15-30r` - NEMA L15-30R\n* `nema-l15-50r` - NEMA L15-50R\n* `nema-l15-60r` - NEMA L15-60R\n* `nema-l21-20r` - NEMA L21-20R\n* `nema-l21-30r` - NEMA L21-30R\n* `nema-l22-20r` - NEMA L22-20R\n* `nema-l22-30r` - NEMA L22-30R\n* `CS6360C` - CS6360C\n* `CS6364C` - CS6364C\n* `CS8164C` - CS8164C\n* `CS8264C` - CS8264C\n* `CS8364C` - CS8364C\n* `CS8464C` - CS8464C\n* `ita-e` - ITA Type E (CEE 7/5)\n* `ita-f` - ITA Type F (CEE 7/3)\n* `ita-g` - ITA Type G (BS 1363)\n* `ita-h` - ITA Type H\n* `ita-i` - ITA Type I\n* `ita-j` - ITA Type J\n* `ita-k` - ITA Type K\n* `ita-l` - ITA Type L (CEI 23-50)\n* `ita-m` - ITA Type M (BS 546)\n* `ita-n` - ITA Type N\n* `ita-o` - ITA Type O\n* `ita-multistandard` - ITA Multistandard\n* `usb-a` - USB Type A\n* `usb-micro-b` - USB Micro B\n* `usb-c` - USB Type C\n* `molex-micro-fit-1x2` - Molex Micro-Fit 1x2\n* `molex-micro-fit-2x2` - Molex Micro-Fit 2x2\n* `molex-micro-fit-2x4` - Molex Micro-Fit 2x4\n* `dc-terminal` - DC Terminal\n* `eaton-c39` - Eaton C39\n* `hdot-cx` - HDOT Cx\n* `saf-d-grid` - Saf-D-Grid\n* `neutrik-powercon-20a` - Neutrik powerCON (20A)\n* `neutrik-powercon-32a` - Neutrik powerCON (32A)\n* `neutrik-powercon-true1` - Neutrik powerCON TRUE1\n* `neutrik-powercon-true1-top` - Neutrik powerCON TRUE1 TOP\n* `ubiquiti-smartpower` - Ubiquiti SmartPower\n* `hardwired` - Hardwired\n* `other` - Other",
"x-spec-enum-id": "8f9617d2648ab261"
},
"label": {
"type": "string",
"enum": [
"C5",
"C7",
"C13",
"C15",
"C17",
"C19",
"C21",
"P+N+E 4H",
"P+N+E 6H",
"P+N+E 9H",
"2P+E 4H",
"2P+E 6H",
"2P+E 9H",
"3P+E 4H",
"3P+E 6H",
"3P+E 9H",
"3P+N+E 4H",
"3P+N+E 6H",
"3P+N+E 9H",
"IEC 60906-1",
"2P+T 10A (NBR 14136)",
"2P+T 20A (NBR 14136)",
"NEMA 1-15R",
"NEMA 5-15R",
"NEMA 5-20R",
"NEMA 5-30R",
"NEMA 5-50R",
"NEMA 6-15R",
"NEMA 6-20R",
"NEMA 6-30R",
"NEMA 6-50R",
"NEMA 10-30R",
"NEMA 10-50R",
"NEMA 14-20R",
"NEMA 14-30R",
"NEMA 14-50R",
"NEMA 14-60R",
"NEMA 15-15R",
"NEMA 15-20R",
"NEMA 15-30R",
"NEMA 15-50R",
"NEMA 15-60R",
"NEMA L1-15R",
"NEMA L5-15R",
"NEMA L5-20R",
"NEMA L5-30R",
"NEMA L5-50R",
"NEMA L6-15R",
"NEMA L6-20R",
"NEMA L6-30R",
"NEMA L6-50R",
"NEMA L10-30R",
"NEMA L14-20R",
"NEMA L14-30R",
"NEMA L14-50R",
"NEMA L14-60R",
"NEMA L15-20R",
"NEMA L15-30R",
"NEMA L15-50R",
"NEMA L15-60R",
"NEMA L21-20R",
"NEMA L21-30R",
"NEMA L22-20R",
"NEMA L22-30R",
"CS6360C",
"CS6364C",
"CS8164C",
"CS8264C",
"CS8364C",
"CS8464C",
"ITA Type E (CEE 7/5)",
"ITA Type F (CEE 7/3)",
"ITA Type G (BS 1363)",
"ITA Type H",
"ITA Type I",
"ITA Type J",
"ITA Type K",
"ITA Type L (CEI 23-50)",
"ITA Type M (BS 546)",
"ITA Type N",
"ITA Type O",
"ITA Multistandard",
"USB Type A",
"USB Micro B",
"USB Type C",
"Molex Micro-Fit 1x2",
"Molex Micro-Fit 2x2",
"Molex Micro-Fit 2x4",
"DC Terminal",
"Eaton C39",
"HDOT Cx",
"Saf-D-Grid",
"Neutrik powerCON (20A)",
"Neutrik powerCON (32A)",
"Neutrik powerCON TRUE1",
"Neutrik powerCON TRUE1 TOP",
"Ubiquiti SmartPower",
"Hardwired",
"Other"
]
}
},
"nullable": true
},
"power_port": {
"allOf": [
{
"$ref": "#/components/schemas/BriefPowerPortTemplate"
}
],
"nullable": true
},
"feed_leg": {
"type": "object",
"properties": {
"value": {
"enum": [
"A",
"B",
"C",
"",
null
],
"type": "string",
"description": "* `A` - A\n* `B` - B\n* `C` - C",
"x-spec-enum-id": "a4902339df0b7c06"
},
"label": {
"type": "string",
"enum": [
"A",
"B",
"C"
]
}
},
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"created",
"display",
"id",
"last_updated",
"name",
"url"
]
},
"PowerOutletTemplateRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"device_type": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefDeviceTypeRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"module_type": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleTypeRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"description": "{module} is accepted as a substitution for the module bay position when attached to a module type.",
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"enum": [
"iec-60320-c5",
"iec-60320-c7",
"iec-60320-c13",
"iec-60320-c15",
"iec-60320-c17",
"iec-60320-c19",
"iec-60320-c21",
"iec-60309-p-n-e-4h",
"iec-60309-p-n-e-6h",
"iec-60309-p-n-e-9h",
"iec-60309-2p-e-4h",
"iec-60309-2p-e-6h",
"iec-60309-2p-e-9h",
"iec-60309-3p-e-4h",
"iec-60309-3p-e-6h",
"iec-60309-3p-e-9h",
"iec-60309-3p-n-e-4h",
"iec-60309-3p-n-e-6h",
"iec-60309-3p-n-e-9h",
"iec-60906-1",
"nbr-14136-10a",
"nbr-14136-20a",
"nema-1-15r",
"nema-5-15r",
"nema-5-20r",
"nema-5-30r",
"nema-5-50r",
"nema-6-15r",
"nema-6-20r",
"nema-6-30r",
"nema-6-50r",
"nema-10-30r",
"nema-10-50r",
"nema-14-20r",
"nema-14-30r",
"nema-14-50r",
"nema-14-60r",
"nema-15-15r",
"nema-15-20r",
"nema-15-30r",
"nema-15-50r",
"nema-15-60r",
"nema-l1-15r",
"nema-l5-15r",
"nema-l5-20r",
"nema-l5-30r",
"nema-l5-50r",
"nema-l6-15r",
"nema-l6-20r",
"nema-l6-30r",
"nema-l6-50r",
"nema-l10-30r",
"nema-l14-20r",
"nema-l14-30r",
"nema-l14-50r",
"nema-l14-60r",
"nema-l15-20r",
"nema-l15-30r",
"nema-l15-50r",
"nema-l15-60r",
"nema-l21-20r",
"nema-l21-30r",
"nema-l22-20r",
"nema-l22-30r",
"CS6360C",
"CS6364C",
"CS8164C",
"CS8264C",
"CS8364C",
"CS8464C",
"ita-e",
"ita-f",
"ita-g",
"ita-h",
"ita-i",
"ita-j",
"ita-k",
"ita-l",
"ita-m",
"ita-n",
"ita-o",
"ita-multistandard",
"usb-a",
"usb-micro-b",
"usb-c",
"molex-micro-fit-1x2",
"molex-micro-fit-2x2",
"molex-micro-fit-2x4",
"dc-terminal",
"eaton-c39",
"hdot-cx",
"saf-d-grid",
"neutrik-powercon-20a",
"neutrik-powercon-32a",
"neutrik-powercon-true1",
"neutrik-powercon-true1-top",
"ubiquiti-smartpower",
"hardwired",
"other",
"",
null
],
"type": "string",
"description": "* `iec-60320-c5` - C5\n* `iec-60320-c7` - C7\n* `iec-60320-c13` - C13\n* `iec-60320-c15` - C15\n* `iec-60320-c17` - C17\n* `iec-60320-c19` - C19\n* `iec-60320-c21` - C21\n* `iec-60309-p-n-e-4h` - P+N+E 4H\n* `iec-60309-p-n-e-6h` - P+N+E 6H\n* `iec-60309-p-n-e-9h` - P+N+E 9H\n* `iec-60309-2p-e-4h` - 2P+E 4H\n* `iec-60309-2p-e-6h` - 2P+E 6H\n* `iec-60309-2p-e-9h` - 2P+E 9H\n* `iec-60309-3p-e-4h` - 3P+E 4H\n* `iec-60309-3p-e-6h` - 3P+E 6H\n* `iec-60309-3p-e-9h` - 3P+E 9H\n* `iec-60309-3p-n-e-4h` - 3P+N+E 4H\n* `iec-60309-3p-n-e-6h` - 3P+N+E 6H\n* `iec-60309-3p-n-e-9h` - 3P+N+E 9H\n* `iec-60906-1` - IEC 60906-1\n* `nbr-14136-10a` - 2P+T 10A (NBR 14136)\n* `nbr-14136-20a` - 2P+T 20A (NBR 14136)\n* `nema-1-15r` - NEMA 1-15R\n* `nema-5-15r` - NEMA 5-15R\n* `nema-5-20r` - NEMA 5-20R\n* `nema-5-30r` - NEMA 5-30R\n* `nema-5-50r` - NEMA 5-50R\n* `nema-6-15r` - NEMA 6-15R\n* `nema-6-20r` - NEMA 6-20R\n* `nema-6-30r` - NEMA 6-30R\n* `nema-6-50r` - NEMA 6-50R\n* `nema-10-30r` - NEMA 10-30R\n* `nema-10-50r` - NEMA 10-50R\n* `nema-14-20r` - NEMA 14-20R\n* `nema-14-30r` - NEMA 14-30R\n* `nema-14-50r` - NEMA 14-50R\n* `nema-14-60r` - NEMA 14-60R\n* `nema-15-15r` - NEMA 15-15R\n* `nema-15-20r` - NEMA 15-20R\n* `nema-15-30r` - NEMA 15-30R\n* `nema-15-50r` - NEMA 15-50R\n* `nema-15-60r` - NEMA 15-60R\n* `nema-l1-15r` - NEMA L1-15R\n* `nema-l5-15r` - NEMA L5-15R\n* `nema-l5-20r` - NEMA L5-20R\n* `nema-l5-30r` - NEMA L5-30R\n* `nema-l5-50r` - NEMA L5-50R\n* `nema-l6-15r` - NEMA L6-15R\n* `nema-l6-20r` - NEMA L6-20R\n* `nema-l6-30r` - NEMA L6-30R\n* `nema-l6-50r` - NEMA L6-50R\n* `nema-l10-30r` - NEMA L10-30R\n* `nema-l14-20r` - NEMA L14-20R\n* `nema-l14-30r` - NEMA L14-30R\n* `nema-l14-50r` - NEMA L14-50R\n* `nema-l14-60r` - NEMA L14-60R\n* `nema-l15-20r` - NEMA L15-20R\n* `nema-l15-30r` - NEMA L15-30R\n* `nema-l15-50r` - NEMA L15-50R\n* `nema-l15-60r` - NEMA L15-60R\n* `nema-l21-20r` - NEMA L21-20R\n* `nema-l21-30r` - NEMA L21-30R\n* `nema-l22-20r` - NEMA L22-20R\n* `nema-l22-30r` - NEMA L22-30R\n* `CS6360C` - CS6360C\n* `CS6364C` - CS6364C\n* `CS8164C` - CS8164C\n* `CS8264C` - CS8264C\n* `CS8364C` - CS8364C\n* `CS8464C` - CS8464C\n* `ita-e` - ITA Type E (CEE 7/5)\n* `ita-f` - ITA Type F (CEE 7/3)\n* `ita-g` - ITA Type G (BS 1363)\n* `ita-h` - ITA Type H\n* `ita-i` - ITA Type I\n* `ita-j` - ITA Type J\n* `ita-k` - ITA Type K\n* `ita-l` - ITA Type L (CEI 23-50)\n* `ita-m` - ITA Type M (BS 546)\n* `ita-n` - ITA Type N\n* `ita-o` - ITA Type O\n* `ita-multistandard` - ITA Multistandard\n* `usb-a` - USB Type A\n* `usb-micro-b` - USB Micro B\n* `usb-c` - USB Type C\n* `molex-micro-fit-1x2` - Molex Micro-Fit 1x2\n* `molex-micro-fit-2x2` - Molex Micro-Fit 2x2\n* `molex-micro-fit-2x4` - Molex Micro-Fit 2x4\n* `dc-terminal` - DC Terminal\n* `eaton-c39` - Eaton C39\n* `hdot-cx` - HDOT Cx\n* `saf-d-grid` - Saf-D-Grid\n* `neutrik-powercon-20a` - Neutrik powerCON (20A)\n* `neutrik-powercon-32a` - Neutrik powerCON (32A)\n* `neutrik-powercon-true1` - Neutrik powerCON TRUE1\n* `neutrik-powercon-true1-top` - Neutrik powerCON TRUE1 TOP\n* `ubiquiti-smartpower` - Ubiquiti SmartPower\n* `hardwired` - Hardwired\n* `other` - Other",
"x-spec-enum-id": "8f9617d2648ab261",
"nullable": true
},
"power_port": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefPowerPortTemplateRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"feed_leg": {
"enum": [
"A",
"B",
"C",
"",
null
],
"type": "string",
"description": "* `A` - A\n* `B` - B\n* `C` - C",
"x-spec-enum-id": "a4902339df0b7c06",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name"
]
},
"PowerPanel": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"site": {
"$ref": "#/components/schemas/BriefSite"
},
"location": {
"allOf": [
{
"$ref": "#/components/schemas/BriefLocation"
}
],
"nullable": true
},
"name": {
"type": "string",
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"powerfeed_count": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"created",
"display",
"display_url",
"id",
"last_updated",
"name",
"powerfeed_count",
"site",
"url"
]
},
"PowerPanelRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"site": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefSiteRequest"
}
]
},
"location": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefLocationRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name",
"site"
]
},
"PowerPort": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"device": {
"$ref": "#/components/schemas/BriefDevice"
},
"module": {
"allOf": [
{
"$ref": "#/components/schemas/BriefModule"
}
],
"nullable": true
},
"name": {
"type": "string",
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"type": "object",
"properties": {
"value": {
"enum": [
"iec-60320-c6",
"iec-60320-c8",
"iec-60320-c14",
"iec-60320-c16",
"iec-60320-c18",
"iec-60320-c20",
"iec-60320-c22",
"iec-60309-p-n-e-4h",
"iec-60309-p-n-e-6h",
"iec-60309-p-n-e-9h",
"iec-60309-2p-e-4h",
"iec-60309-2p-e-6h",
"iec-60309-2p-e-9h",
"iec-60309-3p-e-4h",
"iec-60309-3p-e-6h",
"iec-60309-3p-e-9h",
"iec-60309-3p-n-e-4h",
"iec-60309-3p-n-e-6h",
"iec-60309-3p-n-e-9h",
"iec-60906-1",
"nbr-14136-10a",
"nbr-14136-20a",
"nema-1-15p",
"nema-5-15p",
"nema-5-20p",
"nema-5-30p",
"nema-5-50p",
"nema-6-15p",
"nema-6-20p",
"nema-6-30p",
"nema-6-50p",
"nema-10-30p",
"nema-10-50p",
"nema-14-20p",
"nema-14-30p",
"nema-14-50p",
"nema-14-60p",
"nema-15-15p",
"nema-15-20p",
"nema-15-30p",
"nema-15-50p",
"nema-15-60p",
"nema-l1-15p",
"nema-l5-15p",
"nema-l5-20p",
"nema-l5-30p",
"nema-l5-50p",
"nema-l6-15p",
"nema-l6-20p",
"nema-l6-30p",
"nema-l6-50p",
"nema-l10-30p",
"nema-l14-20p",
"nema-l14-30p",
"nema-l14-50p",
"nema-l14-60p",
"nema-l15-20p",
"nema-l15-30p",
"nema-l15-50p",
"nema-l15-60p",
"nema-l21-20p",
"nema-l21-30p",
"nema-l22-20p",
"nema-l22-30p",
"cs6361c",
"cs6365c",
"cs8165c",
"cs8265c",
"cs8365c",
"cs8465c",
"ita-c",
"ita-e",
"ita-f",
"ita-ef",
"ita-g",
"ita-h",
"ita-i",
"ita-j",
"ita-k",
"ita-l",
"ita-m",
"ita-n",
"ita-o",
"usb-a",
"usb-b",
"usb-c",
"usb-mini-a",
"usb-mini-b",
"usb-micro-a",
"usb-micro-b",
"usb-micro-ab",
"usb-3-b",
"usb-3-micro-b",
"molex-micro-fit-1x2",
"molex-micro-fit-2x2",
"molex-micro-fit-2x4",
"dc-terminal",
"saf-d-grid",
"neutrik-powercon-20",
"neutrik-powercon-32",
"neutrik-powercon-true1",
"neutrik-powercon-true1-top",
"ubiquiti-smartpower",
"hardwired",
"other",
"",
null
],
"type": "string",
"description": "* `iec-60320-c6` - C6\n* `iec-60320-c8` - C8\n* `iec-60320-c14` - C14\n* `iec-60320-c16` - C16\n* `iec-60320-c18` - C18\n* `iec-60320-c20` - C20\n* `iec-60320-c22` - C22\n* `iec-60309-p-n-e-4h` - P+N+E 4H\n* `iec-60309-p-n-e-6h` - P+N+E 6H\n* `iec-60309-p-n-e-9h` - P+N+E 9H\n* `iec-60309-2p-e-4h` - 2P+E 4H\n* `iec-60309-2p-e-6h` - 2P+E 6H\n* `iec-60309-2p-e-9h` - 2P+E 9H\n* `iec-60309-3p-e-4h` - 3P+E 4H\n* `iec-60309-3p-e-6h` - 3P+E 6H\n* `iec-60309-3p-e-9h` - 3P+E 9H\n* `iec-60309-3p-n-e-4h` - 3P+N+E 4H\n* `iec-60309-3p-n-e-6h` - 3P+N+E 6H\n* `iec-60309-3p-n-e-9h` - 3P+N+E 9H\n* `iec-60906-1` - IEC 60906-1\n* `nbr-14136-10a` - 2P+T 10A (NBR 14136)\n* `nbr-14136-20a` - 2P+T 20A (NBR 14136)\n* `nema-1-15p` - NEMA 1-15P\n* `nema-5-15p` - NEMA 5-15P\n* `nema-5-20p` - NEMA 5-20P\n* `nema-5-30p` - NEMA 5-30P\n* `nema-5-50p` - NEMA 5-50P\n* `nema-6-15p` - NEMA 6-15P\n* `nema-6-20p` - NEMA 6-20P\n* `nema-6-30p` - NEMA 6-30P\n* `nema-6-50p` - NEMA 6-50P\n* `nema-10-30p` - NEMA 10-30P\n* `nema-10-50p` - NEMA 10-50P\n* `nema-14-20p` - NEMA 14-20P\n* `nema-14-30p` - NEMA 14-30P\n* `nema-14-50p` - NEMA 14-50P\n* `nema-14-60p` - NEMA 14-60P\n* `nema-15-15p` - NEMA 15-15P\n* `nema-15-20p` - NEMA 15-20P\n* `nema-15-30p` - NEMA 15-30P\n* `nema-15-50p` - NEMA 15-50P\n* `nema-15-60p` - NEMA 15-60P\n* `nema-l1-15p` - NEMA L1-15P\n* `nema-l5-15p` - NEMA L5-15P\n* `nema-l5-20p` - NEMA L5-20P\n* `nema-l5-30p` - NEMA L5-30P\n* `nema-l5-50p` - NEMA L5-50P\n* `nema-l6-15p` - NEMA L6-15P\n* `nema-l6-20p` - NEMA L6-20P\n* `nema-l6-30p` - NEMA L6-30P\n* `nema-l6-50p` - NEMA L6-50P\n* `nema-l10-30p` - NEMA L10-30P\n* `nema-l14-20p` - NEMA L14-20P\n* `nema-l14-30p` - NEMA L14-30P\n* `nema-l14-50p` - NEMA L14-50P\n* `nema-l14-60p` - NEMA L14-60P\n* `nema-l15-20p` - NEMA L15-20P\n* `nema-l15-30p` - NEMA L15-30P\n* `nema-l15-50p` - NEMA L15-50P\n* `nema-l15-60p` - NEMA L15-60P\n* `nema-l21-20p` - NEMA L21-20P\n* `nema-l21-30p` - NEMA L21-30P\n* `nema-l22-20p` - NEMA L22-20P\n* `nema-l22-30p` - NEMA L22-30P\n* `cs6361c` - CS6361C\n* `cs6365c` - CS6365C\n* `cs8165c` - CS8165C\n* `cs8265c` - CS8265C\n* `cs8365c` - CS8365C\n* `cs8465c` - CS8465C\n* `ita-c` - ITA Type C (CEE 7/16)\n* `ita-e` - ITA Type E (CEE 7/6)\n* `ita-f` - ITA Type F (CEE 7/4)\n* `ita-ef` - ITA Type E/F (CEE 7/7)\n* `ita-g` - ITA Type G (BS 1363)\n* `ita-h` - ITA Type H\n* `ita-i` - ITA Type I\n* `ita-j` - ITA Type J\n* `ita-k` - ITA Type K\n* `ita-l` - ITA Type L (CEI 23-50)\n* `ita-m` - ITA Type M (BS 546)\n* `ita-n` - ITA Type N\n* `ita-o` - ITA Type O\n* `usb-a` - USB Type A\n* `usb-b` - USB Type B\n* `usb-c` - USB Type C\n* `usb-mini-a` - USB Mini A\n* `usb-mini-b` - USB Mini B\n* `usb-micro-a` - USB Micro A\n* `usb-micro-b` - USB Micro B\n* `usb-micro-ab` - USB Micro AB\n* `usb-3-b` - USB 3.0 Type B\n* `usb-3-micro-b` - USB 3.0 Micro B\n* `molex-micro-fit-1x2` - Molex Micro-Fit 1x2\n* `molex-micro-fit-2x2` - Molex Micro-Fit 2x2\n* `molex-micro-fit-2x4` - Molex Micro-Fit 2x4\n* `dc-terminal` - DC Terminal\n* `saf-d-grid` - Saf-D-Grid\n* `neutrik-powercon-20` - Neutrik powerCON (20A)\n* `neutrik-powercon-32` - Neutrik powerCON (32A)\n* `neutrik-powercon-true1` - Neutrik powerCON TRUE1\n* `neutrik-powercon-true1-top` - Neutrik powerCON TRUE1 TOP\n* `ubiquiti-smartpower` - Ubiquiti SmartPower\n* `hardwired` - Hardwired\n* `other` - Other",
"x-spec-enum-id": "292850be2c08f7df"
},
"label": {
"type": "string",
"enum": [
"C6",
"C8",
"C14",
"C16",
"C18",
"C20",
"C22",
"P+N+E 4H",
"P+N+E 6H",
"P+N+E 9H",
"2P+E 4H",
"2P+E 6H",
"2P+E 9H",
"3P+E 4H",
"3P+E 6H",
"3P+E 9H",
"3P+N+E 4H",
"3P+N+E 6H",
"3P+N+E 9H",
"IEC 60906-1",
"2P+T 10A (NBR 14136)",
"2P+T 20A (NBR 14136)",
"NEMA 1-15P",
"NEMA 5-15P",
"NEMA 5-20P",
"NEMA 5-30P",
"NEMA 5-50P",
"NEMA 6-15P",
"NEMA 6-20P",
"NEMA 6-30P",
"NEMA 6-50P",
"NEMA 10-30P",
"NEMA 10-50P",
"NEMA 14-20P",
"NEMA 14-30P",
"NEMA 14-50P",
"NEMA 14-60P",
"NEMA 15-15P",
"NEMA 15-20P",
"NEMA 15-30P",
"NEMA 15-50P",
"NEMA 15-60P",
"NEMA L1-15P",
"NEMA L5-15P",
"NEMA L5-20P",
"NEMA L5-30P",
"NEMA L5-50P",
"NEMA L6-15P",
"NEMA L6-20P",
"NEMA L6-30P",
"NEMA L6-50P",
"NEMA L10-30P",
"NEMA L14-20P",
"NEMA L14-30P",
"NEMA L14-50P",
"NEMA L14-60P",
"NEMA L15-20P",
"NEMA L15-30P",
"NEMA L15-50P",
"NEMA L15-60P",
"NEMA L21-20P",
"NEMA L21-30P",
"NEMA L22-20P",
"NEMA L22-30P",
"CS6361C",
"CS6365C",
"CS8165C",
"CS8265C",
"CS8365C",
"CS8465C",
"ITA Type C (CEE 7/16)",
"ITA Type E (CEE 7/6)",
"ITA Type F (CEE 7/4)",
"ITA Type E/F (CEE 7/7)",
"ITA Type G (BS 1363)",
"ITA Type H",
"ITA Type I",
"ITA Type J",
"ITA Type K",
"ITA Type L (CEI 23-50)",
"ITA Type M (BS 546)",
"ITA Type N",
"ITA Type O",
"USB Type A",
"USB Type B",
"USB Type C",
"USB Mini A",
"USB Mini B",
"USB Micro A",
"USB Micro B",
"USB Micro AB",
"USB 3.0 Type B",
"USB 3.0 Micro B",
"Molex Micro-Fit 1x2",
"Molex Micro-Fit 2x2",
"Molex Micro-Fit 2x4",
"DC Terminal",
"Saf-D-Grid",
"Neutrik powerCON (20A)",
"Neutrik powerCON (32A)",
"Neutrik powerCON TRUE1",
"Neutrik powerCON TRUE1 TOP",
"Ubiquiti SmartPower",
"Hardwired",
"Other"
]
}
},
"nullable": true
},
"maximum_draw": {
"type": "integer",
"maximum": 2147483647,
"minimum": 1,
"nullable": true,
"description": "Maximum power draw (watts)"
},
"allocated_draw": {
"type": "integer",
"maximum": 2147483647,
"minimum": 1,
"nullable": true,
"description": "Allocated power draw (watts)"
},
"description": {
"type": "string",
"maxLength": 200
},
"mark_connected": {
"type": "boolean",
"description": "Treat as if a cable is connected"
},
"cable": {
"allOf": [
{
"$ref": "#/components/schemas/BriefCable"
}
],
"readOnly": true,
"nullable": true
},
"cable_end": {
"type": "string",
"readOnly": true
},
"link_peers": {
"type": "array",
"items": {},
"readOnly": true
},
"link_peers_type": {
"type": "string",
"description": "Return the type of the peer link terminations, or None.",
"readOnly": true,
"nullable": true
},
"connected_endpoints": {
"type": "array",
"items": {},
"nullable": true,
"readOnly": true
},
"connected_endpoints_type": {
"type": "string",
"readOnly": true,
"nullable": true
},
"connected_endpoints_reachable": {
"type": "boolean",
"readOnly": true
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"_occupied": {
"type": "boolean",
"readOnly": true,
"title": " occupied"
}
},
"required": [
"_occupied",
"cable",
"cable_end",
"connected_endpoints",
"connected_endpoints_reachable",
"connected_endpoints_type",
"created",
"device",
"display",
"display_url",
"id",
"last_updated",
"link_peers",
"link_peers_type",
"name",
"url"
]
},
"PowerPortRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"device": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDeviceRequest"
}
]
},
"module": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"enum": [
"iec-60320-c6",
"iec-60320-c8",
"iec-60320-c14",
"iec-60320-c16",
"iec-60320-c18",
"iec-60320-c20",
"iec-60320-c22",
"iec-60309-p-n-e-4h",
"iec-60309-p-n-e-6h",
"iec-60309-p-n-e-9h",
"iec-60309-2p-e-4h",
"iec-60309-2p-e-6h",
"iec-60309-2p-e-9h",
"iec-60309-3p-e-4h",
"iec-60309-3p-e-6h",
"iec-60309-3p-e-9h",
"iec-60309-3p-n-e-4h",
"iec-60309-3p-n-e-6h",
"iec-60309-3p-n-e-9h",
"iec-60906-1",
"nbr-14136-10a",
"nbr-14136-20a",
"nema-1-15p",
"nema-5-15p",
"nema-5-20p",
"nema-5-30p",
"nema-5-50p",
"nema-6-15p",
"nema-6-20p",
"nema-6-30p",
"nema-6-50p",
"nema-10-30p",
"nema-10-50p",
"nema-14-20p",
"nema-14-30p",
"nema-14-50p",
"nema-14-60p",
"nema-15-15p",
"nema-15-20p",
"nema-15-30p",
"nema-15-50p",
"nema-15-60p",
"nema-l1-15p",
"nema-l5-15p",
"nema-l5-20p",
"nema-l5-30p",
"nema-l5-50p",
"nema-l6-15p",
"nema-l6-20p",
"nema-l6-30p",
"nema-l6-50p",
"nema-l10-30p",
"nema-l14-20p",
"nema-l14-30p",
"nema-l14-50p",
"nema-l14-60p",
"nema-l15-20p",
"nema-l15-30p",
"nema-l15-50p",
"nema-l15-60p",
"nema-l21-20p",
"nema-l21-30p",
"nema-l22-20p",
"nema-l22-30p",
"cs6361c",
"cs6365c",
"cs8165c",
"cs8265c",
"cs8365c",
"cs8465c",
"ita-c",
"ita-e",
"ita-f",
"ita-ef",
"ita-g",
"ita-h",
"ita-i",
"ita-j",
"ita-k",
"ita-l",
"ita-m",
"ita-n",
"ita-o",
"usb-a",
"usb-b",
"usb-c",
"usb-mini-a",
"usb-mini-b",
"usb-micro-a",
"usb-micro-b",
"usb-micro-ab",
"usb-3-b",
"usb-3-micro-b",
"molex-micro-fit-1x2",
"molex-micro-fit-2x2",
"molex-micro-fit-2x4",
"dc-terminal",
"saf-d-grid",
"neutrik-powercon-20",
"neutrik-powercon-32",
"neutrik-powercon-true1",
"neutrik-powercon-true1-top",
"ubiquiti-smartpower",
"hardwired",
"other",
"",
null
],
"type": "string",
"description": "* `iec-60320-c6` - C6\n* `iec-60320-c8` - C8\n* `iec-60320-c14` - C14\n* `iec-60320-c16` - C16\n* `iec-60320-c18` - C18\n* `iec-60320-c20` - C20\n* `iec-60320-c22` - C22\n* `iec-60309-p-n-e-4h` - P+N+E 4H\n* `iec-60309-p-n-e-6h` - P+N+E 6H\n* `iec-60309-p-n-e-9h` - P+N+E 9H\n* `iec-60309-2p-e-4h` - 2P+E 4H\n* `iec-60309-2p-e-6h` - 2P+E 6H\n* `iec-60309-2p-e-9h` - 2P+E 9H\n* `iec-60309-3p-e-4h` - 3P+E 4H\n* `iec-60309-3p-e-6h` - 3P+E 6H\n* `iec-60309-3p-e-9h` - 3P+E 9H\n* `iec-60309-3p-n-e-4h` - 3P+N+E 4H\n* `iec-60309-3p-n-e-6h` - 3P+N+E 6H\n* `iec-60309-3p-n-e-9h` - 3P+N+E 9H\n* `iec-60906-1` - IEC 60906-1\n* `nbr-14136-10a` - 2P+T 10A (NBR 14136)\n* `nbr-14136-20a` - 2P+T 20A (NBR 14136)\n* `nema-1-15p` - NEMA 1-15P\n* `nema-5-15p` - NEMA 5-15P\n* `nema-5-20p` - NEMA 5-20P\n* `nema-5-30p` - NEMA 5-30P\n* `nema-5-50p` - NEMA 5-50P\n* `nema-6-15p` - NEMA 6-15P\n* `nema-6-20p` - NEMA 6-20P\n* `nema-6-30p` - NEMA 6-30P\n* `nema-6-50p` - NEMA 6-50P\n* `nema-10-30p` - NEMA 10-30P\n* `nema-10-50p` - NEMA 10-50P\n* `nema-14-20p` - NEMA 14-20P\n* `nema-14-30p` - NEMA 14-30P\n* `nema-14-50p` - NEMA 14-50P\n* `nema-14-60p` - NEMA 14-60P\n* `nema-15-15p` - NEMA 15-15P\n* `nema-15-20p` - NEMA 15-20P\n* `nema-15-30p` - NEMA 15-30P\n* `nema-15-50p` - NEMA 15-50P\n* `nema-15-60p` - NEMA 15-60P\n* `nema-l1-15p` - NEMA L1-15P\n* `nema-l5-15p` - NEMA L5-15P\n* `nema-l5-20p` - NEMA L5-20P\n* `nema-l5-30p` - NEMA L5-30P\n* `nema-l5-50p` - NEMA L5-50P\n* `nema-l6-15p` - NEMA L6-15P\n* `nema-l6-20p` - NEMA L6-20P\n* `nema-l6-30p` - NEMA L6-30P\n* `nema-l6-50p` - NEMA L6-50P\n* `nema-l10-30p` - NEMA L10-30P\n* `nema-l14-20p` - NEMA L14-20P\n* `nema-l14-30p` - NEMA L14-30P\n* `nema-l14-50p` - NEMA L14-50P\n* `nema-l14-60p` - NEMA L14-60P\n* `nema-l15-20p` - NEMA L15-20P\n* `nema-l15-30p` - NEMA L15-30P\n* `nema-l15-50p` - NEMA L15-50P\n* `nema-l15-60p` - NEMA L15-60P\n* `nema-l21-20p` - NEMA L21-20P\n* `nema-l21-30p` - NEMA L21-30P\n* `nema-l22-20p` - NEMA L22-20P\n* `nema-l22-30p` - NEMA L22-30P\n* `cs6361c` - CS6361C\n* `cs6365c` - CS6365C\n* `cs8165c` - CS8165C\n* `cs8265c` - CS8265C\n* `cs8365c` - CS8365C\n* `cs8465c` - CS8465C\n* `ita-c` - ITA Type C (CEE 7/16)\n* `ita-e` - ITA Type E (CEE 7/6)\n* `ita-f` - ITA Type F (CEE 7/4)\n* `ita-ef` - ITA Type E/F (CEE 7/7)\n* `ita-g` - ITA Type G (BS 1363)\n* `ita-h` - ITA Type H\n* `ita-i` - ITA Type I\n* `ita-j` - ITA Type J\n* `ita-k` - ITA Type K\n* `ita-l` - ITA Type L (CEI 23-50)\n* `ita-m` - ITA Type M (BS 546)\n* `ita-n` - ITA Type N\n* `ita-o` - ITA Type O\n* `usb-a` - USB Type A\n* `usb-b` - USB Type B\n* `usb-c` - USB Type C\n* `usb-mini-a` - USB Mini A\n* `usb-mini-b` - USB Mini B\n* `usb-micro-a` - USB Micro A\n* `usb-micro-b` - USB Micro B\n* `usb-micro-ab` - USB Micro AB\n* `usb-3-b` - USB 3.0 Type B\n* `usb-3-micro-b` - USB 3.0 Micro B\n* `molex-micro-fit-1x2` - Molex Micro-Fit 1x2\n* `molex-micro-fit-2x2` - Molex Micro-Fit 2x2\n* `molex-micro-fit-2x4` - Molex Micro-Fit 2x4\n* `dc-terminal` - DC Terminal\n* `saf-d-grid` - Saf-D-Grid\n* `neutrik-powercon-20` - Neutrik powerCON (20A)\n* `neutrik-powercon-32` - Neutrik powerCON (32A)\n* `neutrik-powercon-true1` - Neutrik powerCON TRUE1\n* `neutrik-powercon-true1-top` - Neutrik powerCON TRUE1 TOP\n* `ubiquiti-smartpower` - Ubiquiti SmartPower\n* `hardwired` - Hardwired\n* `other` - Other",
"x-spec-enum-id": "292850be2c08f7df",
"nullable": true
},
"maximum_draw": {
"type": "integer",
"maximum": 2147483647,
"minimum": 1,
"nullable": true,
"description": "Maximum power draw (watts)"
},
"allocated_draw": {
"type": "integer",
"maximum": 2147483647,
"minimum": 1,
"nullable": true,
"description": "Allocated power draw (watts)"
},
"description": {
"type": "string",
"maxLength": 200
},
"mark_connected": {
"type": "boolean",
"description": "Treat as if a cable is connected"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"device",
"name"
]
},
"PowerPortTemplate": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"device_type": {
"allOf": [
{
"$ref": "#/components/schemas/BriefDeviceType"
}
],
"nullable": true
},
"module_type": {
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleType"
}
],
"nullable": true
},
"name": {
"type": "string",
"description": "{module} is accepted as a substitution for the module bay position when attached to a module type.",
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"type": "object",
"properties": {
"value": {
"enum": [
"iec-60320-c6",
"iec-60320-c8",
"iec-60320-c14",
"iec-60320-c16",
"iec-60320-c18",
"iec-60320-c20",
"iec-60320-c22",
"iec-60309-p-n-e-4h",
"iec-60309-p-n-e-6h",
"iec-60309-p-n-e-9h",
"iec-60309-2p-e-4h",
"iec-60309-2p-e-6h",
"iec-60309-2p-e-9h",
"iec-60309-3p-e-4h",
"iec-60309-3p-e-6h",
"iec-60309-3p-e-9h",
"iec-60309-3p-n-e-4h",
"iec-60309-3p-n-e-6h",
"iec-60309-3p-n-e-9h",
"iec-60906-1",
"nbr-14136-10a",
"nbr-14136-20a",
"nema-1-15p",
"nema-5-15p",
"nema-5-20p",
"nema-5-30p",
"nema-5-50p",
"nema-6-15p",
"nema-6-20p",
"nema-6-30p",
"nema-6-50p",
"nema-10-30p",
"nema-10-50p",
"nema-14-20p",
"nema-14-30p",
"nema-14-50p",
"nema-14-60p",
"nema-15-15p",
"nema-15-20p",
"nema-15-30p",
"nema-15-50p",
"nema-15-60p",
"nema-l1-15p",
"nema-l5-15p",
"nema-l5-20p",
"nema-l5-30p",
"nema-l5-50p",
"nema-l6-15p",
"nema-l6-20p",
"nema-l6-30p",
"nema-l6-50p",
"nema-l10-30p",
"nema-l14-20p",
"nema-l14-30p",
"nema-l14-50p",
"nema-l14-60p",
"nema-l15-20p",
"nema-l15-30p",
"nema-l15-50p",
"nema-l15-60p",
"nema-l21-20p",
"nema-l21-30p",
"nema-l22-20p",
"nema-l22-30p",
"cs6361c",
"cs6365c",
"cs8165c",
"cs8265c",
"cs8365c",
"cs8465c",
"ita-c",
"ita-e",
"ita-f",
"ita-ef",
"ita-g",
"ita-h",
"ita-i",
"ita-j",
"ita-k",
"ita-l",
"ita-m",
"ita-n",
"ita-o",
"usb-a",
"usb-b",
"usb-c",
"usb-mini-a",
"usb-mini-b",
"usb-micro-a",
"usb-micro-b",
"usb-micro-ab",
"usb-3-b",
"usb-3-micro-b",
"molex-micro-fit-1x2",
"molex-micro-fit-2x2",
"molex-micro-fit-2x4",
"dc-terminal",
"saf-d-grid",
"neutrik-powercon-20",
"neutrik-powercon-32",
"neutrik-powercon-true1",
"neutrik-powercon-true1-top",
"ubiquiti-smartpower",
"hardwired",
"other",
"",
null
],
"type": "string",
"description": "* `iec-60320-c6` - C6\n* `iec-60320-c8` - C8\n* `iec-60320-c14` - C14\n* `iec-60320-c16` - C16\n* `iec-60320-c18` - C18\n* `iec-60320-c20` - C20\n* `iec-60320-c22` - C22\n* `iec-60309-p-n-e-4h` - P+N+E 4H\n* `iec-60309-p-n-e-6h` - P+N+E 6H\n* `iec-60309-p-n-e-9h` - P+N+E 9H\n* `iec-60309-2p-e-4h` - 2P+E 4H\n* `iec-60309-2p-e-6h` - 2P+E 6H\n* `iec-60309-2p-e-9h` - 2P+E 9H\n* `iec-60309-3p-e-4h` - 3P+E 4H\n* `iec-60309-3p-e-6h` - 3P+E 6H\n* `iec-60309-3p-e-9h` - 3P+E 9H\n* `iec-60309-3p-n-e-4h` - 3P+N+E 4H\n* `iec-60309-3p-n-e-6h` - 3P+N+E 6H\n* `iec-60309-3p-n-e-9h` - 3P+N+E 9H\n* `iec-60906-1` - IEC 60906-1\n* `nbr-14136-10a` - 2P+T 10A (NBR 14136)\n* `nbr-14136-20a` - 2P+T 20A (NBR 14136)\n* `nema-1-15p` - NEMA 1-15P\n* `nema-5-15p` - NEMA 5-15P\n* `nema-5-20p` - NEMA 5-20P\n* `nema-5-30p` - NEMA 5-30P\n* `nema-5-50p` - NEMA 5-50P\n* `nema-6-15p` - NEMA 6-15P\n* `nema-6-20p` - NEMA 6-20P\n* `nema-6-30p` - NEMA 6-30P\n* `nema-6-50p` - NEMA 6-50P\n* `nema-10-30p` - NEMA 10-30P\n* `nema-10-50p` - NEMA 10-50P\n* `nema-14-20p` - NEMA 14-20P\n* `nema-14-30p` - NEMA 14-30P\n* `nema-14-50p` - NEMA 14-50P\n* `nema-14-60p` - NEMA 14-60P\n* `nema-15-15p` - NEMA 15-15P\n* `nema-15-20p` - NEMA 15-20P\n* `nema-15-30p` - NEMA 15-30P\n* `nema-15-50p` - NEMA 15-50P\n* `nema-15-60p` - NEMA 15-60P\n* `nema-l1-15p` - NEMA L1-15P\n* `nema-l5-15p` - NEMA L5-15P\n* `nema-l5-20p` - NEMA L5-20P\n* `nema-l5-30p` - NEMA L5-30P\n* `nema-l5-50p` - NEMA L5-50P\n* `nema-l6-15p` - NEMA L6-15P\n* `nema-l6-20p` - NEMA L6-20P\n* `nema-l6-30p` - NEMA L6-30P\n* `nema-l6-50p` - NEMA L6-50P\n* `nema-l10-30p` - NEMA L10-30P\n* `nema-l14-20p` - NEMA L14-20P\n* `nema-l14-30p` - NEMA L14-30P\n* `nema-l14-50p` - NEMA L14-50P\n* `nema-l14-60p` - NEMA L14-60P\n* `nema-l15-20p` - NEMA L15-20P\n* `nema-l15-30p` - NEMA L15-30P\n* `nema-l15-50p` - NEMA L15-50P\n* `nema-l15-60p` - NEMA L15-60P\n* `nema-l21-20p` - NEMA L21-20P\n* `nema-l21-30p` - NEMA L21-30P\n* `nema-l22-20p` - NEMA L22-20P\n* `nema-l22-30p` - NEMA L22-30P\n* `cs6361c` - CS6361C\n* `cs6365c` - CS6365C\n* `cs8165c` - CS8165C\n* `cs8265c` - CS8265C\n* `cs8365c` - CS8365C\n* `cs8465c` - CS8465C\n* `ita-c` - ITA Type C (CEE 7/16)\n* `ita-e` - ITA Type E (CEE 7/6)\n* `ita-f` - ITA Type F (CEE 7/4)\n* `ita-ef` - ITA Type E/F (CEE 7/7)\n* `ita-g` - ITA Type G (BS 1363)\n* `ita-h` - ITA Type H\n* `ita-i` - ITA Type I\n* `ita-j` - ITA Type J\n* `ita-k` - ITA Type K\n* `ita-l` - ITA Type L (CEI 23-50)\n* `ita-m` - ITA Type M (BS 546)\n* `ita-n` - ITA Type N\n* `ita-o` - ITA Type O\n* `usb-a` - USB Type A\n* `usb-b` - USB Type B\n* `usb-c` - USB Type C\n* `usb-mini-a` - USB Mini A\n* `usb-mini-b` - USB Mini B\n* `usb-micro-a` - USB Micro A\n* `usb-micro-b` - USB Micro B\n* `usb-micro-ab` - USB Micro AB\n* `usb-3-b` - USB 3.0 Type B\n* `usb-3-micro-b` - USB 3.0 Micro B\n* `molex-micro-fit-1x2` - Molex Micro-Fit 1x2\n* `molex-micro-fit-2x2` - Molex Micro-Fit 2x2\n* `molex-micro-fit-2x4` - Molex Micro-Fit 2x4\n* `dc-terminal` - DC Terminal\n* `saf-d-grid` - Saf-D-Grid\n* `neutrik-powercon-20` - Neutrik powerCON (20A)\n* `neutrik-powercon-32` - Neutrik powerCON (32A)\n* `neutrik-powercon-true1` - Neutrik powerCON TRUE1\n* `neutrik-powercon-true1-top` - Neutrik powerCON TRUE1 TOP\n* `ubiquiti-smartpower` - Ubiquiti SmartPower\n* `hardwired` - Hardwired\n* `other` - Other",
"x-spec-enum-id": "292850be2c08f7df"
},
"label": {
"type": "string",
"enum": [
"C6",
"C8",
"C14",
"C16",
"C18",
"C20",
"C22",
"P+N+E 4H",
"P+N+E 6H",
"P+N+E 9H",
"2P+E 4H",
"2P+E 6H",
"2P+E 9H",
"3P+E 4H",
"3P+E 6H",
"3P+E 9H",
"3P+N+E 4H",
"3P+N+E 6H",
"3P+N+E 9H",
"IEC 60906-1",
"2P+T 10A (NBR 14136)",
"2P+T 20A (NBR 14136)",
"NEMA 1-15P",
"NEMA 5-15P",
"NEMA 5-20P",
"NEMA 5-30P",
"NEMA 5-50P",
"NEMA 6-15P",
"NEMA 6-20P",
"NEMA 6-30P",
"NEMA 6-50P",
"NEMA 10-30P",
"NEMA 10-50P",
"NEMA 14-20P",
"NEMA 14-30P",
"NEMA 14-50P",
"NEMA 14-60P",
"NEMA 15-15P",
"NEMA 15-20P",
"NEMA 15-30P",
"NEMA 15-50P",
"NEMA 15-60P",
"NEMA L1-15P",
"NEMA L5-15P",
"NEMA L5-20P",
"NEMA L5-30P",
"NEMA L5-50P",
"NEMA L6-15P",
"NEMA L6-20P",
"NEMA L6-30P",
"NEMA L6-50P",
"NEMA L10-30P",
"NEMA L14-20P",
"NEMA L14-30P",
"NEMA L14-50P",
"NEMA L14-60P",
"NEMA L15-20P",
"NEMA L15-30P",
"NEMA L15-50P",
"NEMA L15-60P",
"NEMA L21-20P",
"NEMA L21-30P",
"NEMA L22-20P",
"NEMA L22-30P",
"CS6361C",
"CS6365C",
"CS8165C",
"CS8265C",
"CS8365C",
"CS8465C",
"ITA Type C (CEE 7/16)",
"ITA Type E (CEE 7/6)",
"ITA Type F (CEE 7/4)",
"ITA Type E/F (CEE 7/7)",
"ITA Type G (BS 1363)",
"ITA Type H",
"ITA Type I",
"ITA Type J",
"ITA Type K",
"ITA Type L (CEI 23-50)",
"ITA Type M (BS 546)",
"ITA Type N",
"ITA Type O",
"USB Type A",
"USB Type B",
"USB Type C",
"USB Mini A",
"USB Mini B",
"USB Micro A",
"USB Micro B",
"USB Micro AB",
"USB 3.0 Type B",
"USB 3.0 Micro B",
"Molex Micro-Fit 1x2",
"Molex Micro-Fit 2x2",
"Molex Micro-Fit 2x4",
"DC Terminal",
"Saf-D-Grid",
"Neutrik powerCON (20A)",
"Neutrik powerCON (32A)",
"Neutrik powerCON TRUE1",
"Neutrik powerCON TRUE1 TOP",
"Ubiquiti SmartPower",
"Hardwired",
"Other"
]
}
},
"nullable": true
},
"maximum_draw": {
"type": "integer",
"maximum": 2147483647,
"minimum": 1,
"nullable": true,
"description": "Maximum power draw (watts)"
},
"allocated_draw": {
"type": "integer",
"maximum": 2147483647,
"minimum": 1,
"nullable": true,
"description": "Allocated power draw (watts)"
},
"description": {
"type": "string",
"maxLength": 200
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"created",
"display",
"id",
"last_updated",
"name",
"url"
]
},
"PowerPortTemplateRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"device_type": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefDeviceTypeRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"module_type": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleTypeRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"description": "{module} is accepted as a substitution for the module bay position when attached to a module type.",
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"enum": [
"iec-60320-c6",
"iec-60320-c8",
"iec-60320-c14",
"iec-60320-c16",
"iec-60320-c18",
"iec-60320-c20",
"iec-60320-c22",
"iec-60309-p-n-e-4h",
"iec-60309-p-n-e-6h",
"iec-60309-p-n-e-9h",
"iec-60309-2p-e-4h",
"iec-60309-2p-e-6h",
"iec-60309-2p-e-9h",
"iec-60309-3p-e-4h",
"iec-60309-3p-e-6h",
"iec-60309-3p-e-9h",
"iec-60309-3p-n-e-4h",
"iec-60309-3p-n-e-6h",
"iec-60309-3p-n-e-9h",
"iec-60906-1",
"nbr-14136-10a",
"nbr-14136-20a",
"nema-1-15p",
"nema-5-15p",
"nema-5-20p",
"nema-5-30p",
"nema-5-50p",
"nema-6-15p",
"nema-6-20p",
"nema-6-30p",
"nema-6-50p",
"nema-10-30p",
"nema-10-50p",
"nema-14-20p",
"nema-14-30p",
"nema-14-50p",
"nema-14-60p",
"nema-15-15p",
"nema-15-20p",
"nema-15-30p",
"nema-15-50p",
"nema-15-60p",
"nema-l1-15p",
"nema-l5-15p",
"nema-l5-20p",
"nema-l5-30p",
"nema-l5-50p",
"nema-l6-15p",
"nema-l6-20p",
"nema-l6-30p",
"nema-l6-50p",
"nema-l10-30p",
"nema-l14-20p",
"nema-l14-30p",
"nema-l14-50p",
"nema-l14-60p",
"nema-l15-20p",
"nema-l15-30p",
"nema-l15-50p",
"nema-l15-60p",
"nema-l21-20p",
"nema-l21-30p",
"nema-l22-20p",
"nema-l22-30p",
"cs6361c",
"cs6365c",
"cs8165c",
"cs8265c",
"cs8365c",
"cs8465c",
"ita-c",
"ita-e",
"ita-f",
"ita-ef",
"ita-g",
"ita-h",
"ita-i",
"ita-j",
"ita-k",
"ita-l",
"ita-m",
"ita-n",
"ita-o",
"usb-a",
"usb-b",
"usb-c",
"usb-mini-a",
"usb-mini-b",
"usb-micro-a",
"usb-micro-b",
"usb-micro-ab",
"usb-3-b",
"usb-3-micro-b",
"molex-micro-fit-1x2",
"molex-micro-fit-2x2",
"molex-micro-fit-2x4",
"dc-terminal",
"saf-d-grid",
"neutrik-powercon-20",
"neutrik-powercon-32",
"neutrik-powercon-true1",
"neutrik-powercon-true1-top",
"ubiquiti-smartpower",
"hardwired",
"other",
"",
null
],
"type": "string",
"description": "* `iec-60320-c6` - C6\n* `iec-60320-c8` - C8\n* `iec-60320-c14` - C14\n* `iec-60320-c16` - C16\n* `iec-60320-c18` - C18\n* `iec-60320-c20` - C20\n* `iec-60320-c22` - C22\n* `iec-60309-p-n-e-4h` - P+N+E 4H\n* `iec-60309-p-n-e-6h` - P+N+E 6H\n* `iec-60309-p-n-e-9h` - P+N+E 9H\n* `iec-60309-2p-e-4h` - 2P+E 4H\n* `iec-60309-2p-e-6h` - 2P+E 6H\n* `iec-60309-2p-e-9h` - 2P+E 9H\n* `iec-60309-3p-e-4h` - 3P+E 4H\n* `iec-60309-3p-e-6h` - 3P+E 6H\n* `iec-60309-3p-e-9h` - 3P+E 9H\n* `iec-60309-3p-n-e-4h` - 3P+N+E 4H\n* `iec-60309-3p-n-e-6h` - 3P+N+E 6H\n* `iec-60309-3p-n-e-9h` - 3P+N+E 9H\n* `iec-60906-1` - IEC 60906-1\n* `nbr-14136-10a` - 2P+T 10A (NBR 14136)\n* `nbr-14136-20a` - 2P+T 20A (NBR 14136)\n* `nema-1-15p` - NEMA 1-15P\n* `nema-5-15p` - NEMA 5-15P\n* `nema-5-20p` - NEMA 5-20P\n* `nema-5-30p` - NEMA 5-30P\n* `nema-5-50p` - NEMA 5-50P\n* `nema-6-15p` - NEMA 6-15P\n* `nema-6-20p` - NEMA 6-20P\n* `nema-6-30p` - NEMA 6-30P\n* `nema-6-50p` - NEMA 6-50P\n* `nema-10-30p` - NEMA 10-30P\n* `nema-10-50p` - NEMA 10-50P\n* `nema-14-20p` - NEMA 14-20P\n* `nema-14-30p` - NEMA 14-30P\n* `nema-14-50p` - NEMA 14-50P\n* `nema-14-60p` - NEMA 14-60P\n* `nema-15-15p` - NEMA 15-15P\n* `nema-15-20p` - NEMA 15-20P\n* `nema-15-30p` - NEMA 15-30P\n* `nema-15-50p` - NEMA 15-50P\n* `nema-15-60p` - NEMA 15-60P\n* `nema-l1-15p` - NEMA L1-15P\n* `nema-l5-15p` - NEMA L5-15P\n* `nema-l5-20p` - NEMA L5-20P\n* `nema-l5-30p` - NEMA L5-30P\n* `nema-l5-50p` - NEMA L5-50P\n* `nema-l6-15p` - NEMA L6-15P\n* `nema-l6-20p` - NEMA L6-20P\n* `nema-l6-30p` - NEMA L6-30P\n* `nema-l6-50p` - NEMA L6-50P\n* `nema-l10-30p` - NEMA L10-30P\n* `nema-l14-20p` - NEMA L14-20P\n* `nema-l14-30p` - NEMA L14-30P\n* `nema-l14-50p` - NEMA L14-50P\n* `nema-l14-60p` - NEMA L14-60P\n* `nema-l15-20p` - NEMA L15-20P\n* `nema-l15-30p` - NEMA L15-30P\n* `nema-l15-50p` - NEMA L15-50P\n* `nema-l15-60p` - NEMA L15-60P\n* `nema-l21-20p` - NEMA L21-20P\n* `nema-l21-30p` - NEMA L21-30P\n* `nema-l22-20p` - NEMA L22-20P\n* `nema-l22-30p` - NEMA L22-30P\n* `cs6361c` - CS6361C\n* `cs6365c` - CS6365C\n* `cs8165c` - CS8165C\n* `cs8265c` - CS8265C\n* `cs8365c` - CS8365C\n* `cs8465c` - CS8465C\n* `ita-c` - ITA Type C (CEE 7/16)\n* `ita-e` - ITA Type E (CEE 7/6)\n* `ita-f` - ITA Type F (CEE 7/4)\n* `ita-ef` - ITA Type E/F (CEE 7/7)\n* `ita-g` - ITA Type G (BS 1363)\n* `ita-h` - ITA Type H\n* `ita-i` - ITA Type I\n* `ita-j` - ITA Type J\n* `ita-k` - ITA Type K\n* `ita-l` - ITA Type L (CEI 23-50)\n* `ita-m` - ITA Type M (BS 546)\n* `ita-n` - ITA Type N\n* `ita-o` - ITA Type O\n* `usb-a` - USB Type A\n* `usb-b` - USB Type B\n* `usb-c` - USB Type C\n* `usb-mini-a` - USB Mini A\n* `usb-mini-b` - USB Mini B\n* `usb-micro-a` - USB Micro A\n* `usb-micro-b` - USB Micro B\n* `usb-micro-ab` - USB Micro AB\n* `usb-3-b` - USB 3.0 Type B\n* `usb-3-micro-b` - USB 3.0 Micro B\n* `molex-micro-fit-1x2` - Molex Micro-Fit 1x2\n* `molex-micro-fit-2x2` - Molex Micro-Fit 2x2\n* `molex-micro-fit-2x4` - Molex Micro-Fit 2x4\n* `dc-terminal` - DC Terminal\n* `saf-d-grid` - Saf-D-Grid\n* `neutrik-powercon-20` - Neutrik powerCON (20A)\n* `neutrik-powercon-32` - Neutrik powerCON (32A)\n* `neutrik-powercon-true1` - Neutrik powerCON TRUE1\n* `neutrik-powercon-true1-top` - Neutrik powerCON TRUE1 TOP\n* `ubiquiti-smartpower` - Ubiquiti SmartPower\n* `hardwired` - Hardwired\n* `other` - Other",
"x-spec-enum-id": "292850be2c08f7df",
"nullable": true
},
"maximum_draw": {
"type": "integer",
"maximum": 2147483647,
"minimum": 1,
"nullable": true,
"description": "Maximum power draw (watts)"
},
"allocated_draw": {
"type": "integer",
"maximum": 2147483647,
"minimum": 1,
"nullable": true,
"description": "Allocated power draw (watts)"
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name"
]
},
"Prefix": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"family": {
"type": "object",
"properties": {
"value": {
"enum": [
4,
6
],
"type": "integer",
"description": "* `4` - IPv4\n* `6` - IPv6",
"x-spec-enum-id": "d72003fd1af3603d"
},
"label": {
"type": "string",
"enum": [
"IPv4",
"IPv6"
]
}
},
"readOnly": true
},
"prefix": {
"type": "string"
},
"vrf": {
"allOf": [
{
"$ref": "#/components/schemas/BriefVRF"
}
],
"nullable": true
},
"scope_type": {
"type": "string",
"nullable": true
},
"scope_id": {
"type": "integer",
"nullable": true
},
"scope": {
"nullable": true,
"readOnly": true
},
"tenant": {
"allOf": [
{
"$ref": "#/components/schemas/BriefTenant"
}
],
"nullable": true
},
"vlan": {
"allOf": [
{
"$ref": "#/components/schemas/BriefVLAN"
}
],
"nullable": true
},
"status": {
"type": "object",
"properties": {
"value": {
"enum": [
"container",
"active",
"reserved",
"deprecated"
],
"type": "string",
"description": "* `container` - Container\n* `active` - Active\n* `reserved` - Reserved\n* `deprecated` - Deprecated",
"x-spec-enum-id": "d38bee5f512701d9"
},
"label": {
"type": "string",
"enum": [
"Container",
"Active",
"Reserved",
"Deprecated"
]
}
}
},
"role": {
"allOf": [
{
"$ref": "#/components/schemas/BriefRole"
}
],
"nullable": true
},
"is_pool": {
"type": "boolean",
"title": "Is a pool",
"description": "All IP addresses within this prefix are considered usable"
},
"mark_utilized": {
"type": "boolean",
"description": "Treat as fully utilized"
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"children": {
"type": "integer",
"readOnly": true
},
"_depth": {
"type": "integer",
"readOnly": true,
"title": " depth"
}
},
"required": [
"_depth",
"children",
"created",
"display",
"display_url",
"family",
"id",
"last_updated",
"prefix",
"scope",
"url"
]
},
"PrefixRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"prefix": {
"type": "string",
"minLength": 1
},
"vrf": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefVRFRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"scope_type": {
"type": "string",
"nullable": true
},
"scope_id": {
"type": "integer",
"nullable": true
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"vlan": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefVLANRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"status": {
"enum": [
"container",
"active",
"reserved",
"deprecated"
],
"type": "string",
"description": "* `container` - Container\n* `active` - Active\n* `reserved` - Reserved\n* `deprecated` - Deprecated",
"x-spec-enum-id": "d38bee5f512701d9"
},
"role": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefRoleRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"is_pool": {
"type": "boolean",
"title": "Is a pool",
"description": "All IP addresses within this prefix are considered usable"
},
"mark_utilized": {
"type": "boolean",
"description": "Treat as fully utilized"
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"prefix"
]
},
"Provider": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"description": "Full name of the provider",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"accounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedProviderAccount"
}
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"asns": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ASN"
}
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"circuit_count": {
"type": "integer",
"format": "int64",
"readOnly": true
}
},
"required": [
"circuit_count",
"created",
"display",
"display_url",
"id",
"last_updated",
"name",
"slug",
"url"
]
},
"ProviderAccount": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"provider": {
"$ref": "#/components/schemas/BriefProvider"
},
"name": {
"type": "string",
"default": "",
"maxLength": 100
},
"account": {
"type": "string",
"title": "Account ID",
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"account",
"created",
"display",
"display_url",
"id",
"last_updated",
"provider",
"url"
]
},
"ProviderAccountRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"provider": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefProviderRequest"
}
]
},
"name": {
"type": "string",
"default": "",
"maxLength": 100
},
"account": {
"type": "string",
"minLength": 1,
"title": "Account ID",
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"account",
"provider"
]
},
"ProviderNetwork": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"provider": {
"$ref": "#/components/schemas/BriefProvider"
},
"name": {
"type": "string",
"maxLength": 100
},
"service_id": {
"type": "string",
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"created",
"display",
"display_url",
"id",
"last_updated",
"name",
"provider",
"url"
]
},
"ProviderNetworkRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"provider": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefProviderRequest"
}
]
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"service_id": {
"type": "string",
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name",
"provider"
]
},
"ProviderRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"description": "Full name of the provider",
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"accounts": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"asns": {
"type": "array",
"items": {
"type": "integer"
}
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name",
"slug"
]
},
"RIR": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"is_private": {
"type": "boolean",
"title": "Private",
"description": "IP space managed by this RIR is considered private"
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"aggregate_count": {
"type": "integer",
"format": "int64",
"readOnly": true
}
},
"required": [
"aggregate_count",
"created",
"display",
"display_url",
"id",
"last_updated",
"name",
"slug",
"url"
]
},
"RIRRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"is_private": {
"type": "boolean",
"title": "Private",
"description": "IP space managed by this RIR is considered private"
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name",
"slug"
]
},
"Rack": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"facility_id": {
"type": "string",
"nullable": true,
"maxLength": 50
},
"site": {
"$ref": "#/components/schemas/BriefSite"
},
"location": {
"allOf": [
{
"$ref": "#/components/schemas/BriefLocation"
}
],
"nullable": true
},
"tenant": {
"allOf": [
{
"$ref": "#/components/schemas/BriefTenant"
}
],
"nullable": true
},
"status": {
"type": "object",
"properties": {
"value": {
"enum": [
"reserved",
"available",
"planned",
"active",
"deprecated"
],
"type": "string",
"description": "* `reserved` - Reserved\n* `available` - Available\n* `planned` - Planned\n* `active` - Active\n* `deprecated` - Deprecated",
"x-spec-enum-id": "0c556d55dc1baa13"
},
"label": {
"type": "string",
"enum": [
"Reserved",
"Available",
"Planned",
"Active",
"Deprecated"
]
}
}
},
"role": {
"allOf": [
{
"$ref": "#/components/schemas/BriefRackRole"
}
],
"nullable": true
},
"serial": {
"type": "string",
"title": "Serial number",
"maxLength": 50
},
"asset_tag": {
"type": "string",
"nullable": true,
"description": "A unique tag used to identify this rack",
"maxLength": 50
},
"rack_type": {
"allOf": [
{
"$ref": "#/components/schemas/BriefRackType"
}
],
"nullable": true
},
"form_factor": {
"type": "object",
"properties": {
"value": {
"enum": [
"2-post-frame",
"4-post-frame",
"4-post-cabinet",
"wall-frame",
"wall-frame-vertical",
"wall-cabinet",
"wall-cabinet-vertical",
"",
null
],
"type": "string",
"description": "* `2-post-frame` - 2-post frame\n* `4-post-frame` - 4-post frame\n* `4-post-cabinet` - 4-post cabinet\n* `wall-frame` - Wall-mounted frame\n* `wall-frame-vertical` - Wall-mounted frame (vertical)\n* `wall-cabinet` - Wall-mounted cabinet\n* `wall-cabinet-vertical` - Wall-mounted cabinet (vertical)",
"x-spec-enum-id": "e32aaa89a223f2ea"
},
"label": {
"type": "string",
"enum": [
"2-post frame",
"4-post frame",
"4-post cabinet",
"Wall-mounted frame",
"Wall-mounted frame (vertical)",
"Wall-mounted cabinet",
"Wall-mounted cabinet (vertical)"
]
}
},
"nullable": true
},
"width": {
"type": "object",
"properties": {
"value": {
"enum": [
10,
19,
21,
23
],
"type": "integer",
"description": "* `10` - 10 inches\n* `19` - 19 inches\n* `21` - 21 inches\n* `23` - 23 inches",
"x-spec-enum-id": "9b322795f297a9c3"
},
"label": {
"type": "string",
"enum": [
"10 inches",
"19 inches",
"21 inches",
"23 inches"
]
}
}
},
"u_height": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"title": "Height (U)",
"description": "Height in rack units"
},
"starting_unit": {
"type": "integer",
"maximum": 32767,
"minimum": 1,
"description": "Starting unit for rack"
},
"weight": {
"type": "number",
"format": "double",
"maximum": 1000000,
"minimum": -1000000,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true
},
"max_weight": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"description": "Maximum load capacity for the rack"
},
"weight_unit": {
"type": "object",
"properties": {
"value": {
"enum": [
"kg",
"g",
"lb",
"oz",
"",
null
],
"type": "string",
"description": "* `kg` - Kilograms\n* `g` - Grams\n* `lb` - Pounds\n* `oz` - Ounces",
"x-spec-enum-id": "7c1876f422815884"
},
"label": {
"type": "string",
"enum": [
"Kilograms",
"Grams",
"Pounds",
"Ounces"
]
}
},
"nullable": true
},
"desc_units": {
"type": "boolean",
"title": "Descending units",
"description": "Units are numbered top-to-bottom"
},
"outer_width": {
"type": "integer",
"maximum": 32767,
"minimum": 0,
"nullable": true,
"description": "Outer dimension of rack (width)"
},
"outer_height": {
"type": "integer",
"maximum": 32767,
"minimum": 0,
"nullable": true,
"description": "Outer dimension of rack (height)"
},
"outer_depth": {
"type": "integer",
"maximum": 32767,
"minimum": 0,
"nullable": true,
"description": "Outer dimension of rack (depth)"
},
"outer_unit": {
"type": "object",
"properties": {
"value": {
"enum": [
"mm",
"in",
"",
null
],
"type": "string",
"description": "* `mm` - Millimeters\n* `in` - Inches",
"x-spec-enum-id": "86a846b6c40f495e"
},
"label": {
"type": "string",
"enum": [
"Millimeters",
"Inches"
]
}
},
"nullable": true
},
"mounting_depth": {
"type": "integer",
"maximum": 32767,
"minimum": 0,
"nullable": true,
"description": "Maximum depth of a mounted device, in millimeters. For four-post racks, this is the distance between the front and rear rails."
},
"airflow": {
"type": "object",
"properties": {
"value": {
"enum": [
"front-to-rear",
"rear-to-front",
""
],
"type": "string",
"description": "* `front-to-rear` - Front to rear\n* `rear-to-front` - Rear to front",
"x-spec-enum-id": "a784734d07ef1b3c"
},
"label": {
"type": "string",
"enum": [
"Front to rear",
"Rear to front"
]
}
}
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"device_count": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"powerfeed_count": {
"type": "integer",
"format": "int64",
"readOnly": true
}
},
"required": [
"created",
"device_count",
"display",
"display_url",
"id",
"last_updated",
"name",
"powerfeed_count",
"site",
"url"
]
},
"RackRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"facility_id": {
"type": "string",
"nullable": true,
"maxLength": 50
},
"site": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefSiteRequest"
}
]
},
"location": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefLocationRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"status": {
"enum": [
"reserved",
"available",
"planned",
"active",
"deprecated"
],
"type": "string",
"description": "* `reserved` - Reserved\n* `available` - Available\n* `planned` - Planned\n* `active` - Active\n* `deprecated` - Deprecated",
"x-spec-enum-id": "0c556d55dc1baa13"
},
"role": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefRackRoleRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"serial": {
"type": "string",
"title": "Serial number",
"maxLength": 50
},
"asset_tag": {
"type": "string",
"nullable": true,
"description": "A unique tag used to identify this rack",
"maxLength": 50
},
"rack_type": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefRackTypeRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"form_factor": {
"enum": [
"2-post-frame",
"4-post-frame",
"4-post-cabinet",
"wall-frame",
"wall-frame-vertical",
"wall-cabinet",
"wall-cabinet-vertical",
"",
null
],
"type": "string",
"description": "* `2-post-frame` - 2-post frame\n* `4-post-frame` - 4-post frame\n* `4-post-cabinet` - 4-post cabinet\n* `wall-frame` - Wall-mounted frame\n* `wall-frame-vertical` - Wall-mounted frame (vertical)\n* `wall-cabinet` - Wall-mounted cabinet\n* `wall-cabinet-vertical` - Wall-mounted cabinet (vertical)",
"x-spec-enum-id": "e32aaa89a223f2ea",
"nullable": true
},
"width": {
"enum": [
10,
19,
21,
23
],
"type": "integer",
"description": "* `10` - 10 inches\n* `19` - 19 inches\n* `21` - 21 inches\n* `23` - 23 inches",
"x-spec-enum-id": "9b322795f297a9c3"
},
"u_height": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"title": "Height (U)",
"description": "Height in rack units"
},
"starting_unit": {
"type": "integer",
"maximum": 32767,
"minimum": 1,
"description": "Starting unit for rack"
},
"weight": {
"type": "number",
"format": "double",
"maximum": 1000000,
"minimum": -1000000,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true
},
"max_weight": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"description": "Maximum load capacity for the rack"
},
"weight_unit": {
"enum": [
"kg",
"g",
"lb",
"oz",
"",
null
],
"type": "string",
"description": "* `kg` - Kilograms\n* `g` - Grams\n* `lb` - Pounds\n* `oz` - Ounces",
"x-spec-enum-id": "7c1876f422815884",
"nullable": true
},
"desc_units": {
"type": "boolean",
"title": "Descending units",
"description": "Units are numbered top-to-bottom"
},
"outer_width": {
"type": "integer",
"maximum": 32767,
"minimum": 0,
"nullable": true,
"description": "Outer dimension of rack (width)"
},
"outer_height": {
"type": "integer",
"maximum": 32767,
"minimum": 0,
"nullable": true,
"description": "Outer dimension of rack (height)"
},
"outer_depth": {
"type": "integer",
"maximum": 32767,
"minimum": 0,
"nullable": true,
"description": "Outer dimension of rack (depth)"
},
"outer_unit": {
"enum": [
"mm",
"in",
"",
null
],
"type": "string",
"description": "* `mm` - Millimeters\n* `in` - Inches",
"x-spec-enum-id": "86a846b6c40f495e",
"nullable": true
},
"mounting_depth": {
"type": "integer",
"maximum": 32767,
"minimum": 0,
"nullable": true,
"description": "Maximum depth of a mounted device, in millimeters. For four-post racks, this is the distance between the front and rear rails."
},
"airflow": {
"enum": [
"front-to-rear",
"rear-to-front",
""
],
"type": "string",
"description": "* `front-to-rear` - Front to rear\n* `rear-to-front` - Rear to front",
"x-spec-enum-id": "a784734d07ef1b3c"
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name",
"site"
]
},
"RackReservation": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"rack": {
"$ref": "#/components/schemas/BriefRack"
},
"units": {
"type": "array",
"items": {
"type": "integer",
"maximum": 32767,
"minimum": 0
}
},
"status": {
"type": "object",
"properties": {
"value": {
"enum": [
"pending",
"active",
"stale"
],
"type": "string",
"description": "* `pending` - Pending\n* `active` - Active\n* `stale` - Stale",
"x-spec-enum-id": "b62013475549e423"
},
"label": {
"type": "string",
"enum": [
"Pending",
"Active",
"Stale"
]
}
}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"user": {
"$ref": "#/components/schemas/BriefUser"
},
"tenant": {
"allOf": [
{
"$ref": "#/components/schemas/BriefTenant"
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"created",
"description",
"display",
"display_url",
"id",
"last_updated",
"rack",
"units",
"url",
"user"
]
},
"RackReservationRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"rack": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefRackRequest"
}
]
},
"units": {
"type": "array",
"items": {
"type": "integer",
"maximum": 32767,
"minimum": 0
}
},
"status": {
"enum": [
"pending",
"active",
"stale"
],
"type": "string",
"description": "* `pending` - Pending\n* `active` - Active\n* `stale` - Stale",
"x-spec-enum-id": "b62013475549e423"
},
"user": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefUserRequest"
}
]
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"description": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"description",
"rack",
"units",
"user"
]
},
"RackRole": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"color": {
"type": "string",
"pattern": "^[0-9a-f]{6}$",
"maxLength": 6
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"rack_count": {
"type": "integer",
"format": "int64",
"readOnly": true
}
},
"required": [
"created",
"display",
"display_url",
"id",
"last_updated",
"name",
"rack_count",
"slug",
"url"
]
},
"RackRoleRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"color": {
"type": "string",
"minLength": 1,
"pattern": "^[0-9a-f]{6}$",
"maxLength": 6
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name",
"slug"
]
},
"RackType": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"manufacturer": {
"$ref": "#/components/schemas/BriefManufacturer"
},
"model": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
},
"form_factor": {
"type": "object",
"properties": {
"value": {
"enum": [
"2-post-frame",
"4-post-frame",
"4-post-cabinet",
"wall-frame",
"wall-frame-vertical",
"wall-cabinet",
"wall-cabinet-vertical",
"",
null
],
"type": "string",
"description": "* `2-post-frame` - 2-post frame\n* `4-post-frame` - 4-post frame\n* `4-post-cabinet` - 4-post cabinet\n* `wall-frame` - Wall-mounted frame\n* `wall-frame-vertical` - Wall-mounted frame (vertical)\n* `wall-cabinet` - Wall-mounted cabinet\n* `wall-cabinet-vertical` - Wall-mounted cabinet (vertical)",
"x-spec-enum-id": "e32aaa89a223f2ea"
},
"label": {
"type": "string",
"enum": [
"2-post frame",
"4-post frame",
"4-post cabinet",
"Wall-mounted frame",
"Wall-mounted frame (vertical)",
"Wall-mounted cabinet",
"Wall-mounted cabinet (vertical)"
]
}
},
"nullable": true
},
"width": {
"type": "object",
"properties": {
"value": {
"enum": [
10,
19,
21,
23
],
"type": "integer",
"description": "* `10` - 10 inches\n* `19` - 19 inches\n* `21` - 21 inches\n* `23` - 23 inches",
"x-spec-enum-id": "9b322795f297a9c3"
},
"label": {
"type": "string",
"enum": [
"10 inches",
"19 inches",
"21 inches",
"23 inches"
]
}
}
},
"u_height": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"title": "Height (U)",
"description": "Height in rack units"
},
"starting_unit": {
"type": "integer",
"maximum": 32767,
"minimum": 1,
"description": "Starting unit for rack"
},
"desc_units": {
"type": "boolean",
"title": "Descending units",
"description": "Units are numbered top-to-bottom"
},
"outer_width": {
"type": "integer",
"maximum": 32767,
"minimum": 0,
"nullable": true,
"description": "Outer dimension of rack (width)"
},
"outer_height": {
"type": "integer",
"maximum": 32767,
"minimum": 0,
"nullable": true,
"description": "Outer dimension of rack (height)"
},
"outer_depth": {
"type": "integer",
"maximum": 32767,
"minimum": 0,
"nullable": true,
"description": "Outer dimension of rack (depth)"
},
"outer_unit": {
"type": "object",
"properties": {
"value": {
"enum": [
"mm",
"in",
"",
null
],
"type": "string",
"description": "* `mm` - Millimeters\n* `in` - Inches",
"x-spec-enum-id": "86a846b6c40f495e"
},
"label": {
"type": "string",
"enum": [
"Millimeters",
"Inches"
]
}
},
"nullable": true
},
"weight": {
"type": "number",
"format": "double",
"maximum": 1000000,
"minimum": -1000000,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true
},
"max_weight": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"description": "Maximum load capacity for the rack"
},
"weight_unit": {
"type": "object",
"properties": {
"value": {
"enum": [
"kg",
"g",
"lb",
"oz",
"",
null
],
"type": "string",
"description": "* `kg` - Kilograms\n* `g` - Grams\n* `lb` - Pounds\n* `oz` - Ounces",
"x-spec-enum-id": "7c1876f422815884"
},
"label": {
"type": "string",
"enum": [
"Kilograms",
"Grams",
"Pounds",
"Ounces"
]
}
},
"nullable": true
},
"mounting_depth": {
"type": "integer",
"maximum": 32767,
"minimum": 0,
"nullable": true,
"description": "Maximum depth of a mounted device, in millimeters. For four-post racks, this is the distance between the front and rear rails."
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"created",
"display",
"display_url",
"id",
"last_updated",
"manufacturer",
"model",
"slug",
"url"
]
},
"RackTypeRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"manufacturer": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefManufacturerRequest"
}
]
},
"model": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
},
"form_factor": {
"enum": [
"2-post-frame",
"4-post-frame",
"4-post-cabinet",
"wall-frame",
"wall-frame-vertical",
"wall-cabinet",
"wall-cabinet-vertical",
"",
null
],
"type": "string",
"description": "* `2-post-frame` - 2-post frame\n* `4-post-frame` - 4-post frame\n* `4-post-cabinet` - 4-post cabinet\n* `wall-frame` - Wall-mounted frame\n* `wall-frame-vertical` - Wall-mounted frame (vertical)\n* `wall-cabinet` - Wall-mounted cabinet\n* `wall-cabinet-vertical` - Wall-mounted cabinet (vertical)",
"x-spec-enum-id": "e32aaa89a223f2ea",
"nullable": true
},
"width": {
"enum": [
10,
19,
21,
23
],
"type": "integer",
"description": "* `10` - 10 inches\n* `19` - 19 inches\n* `21` - 21 inches\n* `23` - 23 inches",
"x-spec-enum-id": "9b322795f297a9c3"
},
"u_height": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"title": "Height (U)",
"description": "Height in rack units"
},
"starting_unit": {
"type": "integer",
"maximum": 32767,
"minimum": 1,
"description": "Starting unit for rack"
},
"desc_units": {
"type": "boolean",
"title": "Descending units",
"description": "Units are numbered top-to-bottom"
},
"outer_width": {
"type": "integer",
"maximum": 32767,
"minimum": 0,
"nullable": true,
"description": "Outer dimension of rack (width)"
},
"outer_height": {
"type": "integer",
"maximum": 32767,
"minimum": 0,
"nullable": true,
"description": "Outer dimension of rack (height)"
},
"outer_depth": {
"type": "integer",
"maximum": 32767,
"minimum": 0,
"nullable": true,
"description": "Outer dimension of rack (depth)"
},
"outer_unit": {
"enum": [
"mm",
"in",
"",
null
],
"type": "string",
"description": "* `mm` - Millimeters\n* `in` - Inches",
"x-spec-enum-id": "86a846b6c40f495e",
"nullable": true
},
"weight": {
"type": "number",
"format": "double",
"maximum": 1000000,
"minimum": -1000000,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true
},
"max_weight": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"description": "Maximum load capacity for the rack"
},
"weight_unit": {
"enum": [
"kg",
"g",
"lb",
"oz",
"",
null
],
"type": "string",
"description": "* `kg` - Kilograms\n* `g` - Grams\n* `lb` - Pounds\n* `oz` - Ounces",
"x-spec-enum-id": "7c1876f422815884",
"nullable": true
},
"mounting_depth": {
"type": "integer",
"maximum": 32767,
"minimum": 0,
"nullable": true,
"description": "Maximum depth of a mounted device, in millimeters. For four-post racks, this is the distance between the front and rear rails."
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"manufacturer",
"model",
"slug"
]
},
"RackUnit": {
"type": "object",
"description": "A rack unit is an abstraction formed by the set (rack, position, face); it does not exist as a row in the database.",
"properties": {
"id": {
"type": "number",
"format": "double",
"maximum": 1000,
"minimum": -1000,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"readOnly": true
},
"name": {
"type": "string",
"readOnly": true
},
"face": {
"type": "object",
"properties": {
"value": {
"enum": [
"front",
"rear"
],
"type": "string",
"description": "* `front` - Front\n* `rear` - Rear",
"x-spec-enum-id": "d2fb9b3f75158b83"
},
"label": {
"type": "string",
"enum": [
"Front",
"Rear"
]
}
},
"readOnly": true
},
"device": {
"allOf": [
{
"$ref": "#/components/schemas/BriefDevice"
}
],
"readOnly": true
},
"occupied": {
"type": "boolean",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
}
},
"required": [
"device",
"display",
"face",
"id",
"name",
"occupied"
]
},
"RearPort": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"device": {
"$ref": "#/components/schemas/BriefDevice"
},
"module": {
"allOf": [
{
"$ref": "#/components/schemas/BriefModule"
}
],
"nullable": true
},
"name": {
"type": "string",
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"type": "object",
"properties": {
"value": {
"enum": [
"8p8c",
"8p6c",
"8p4c",
"8p2c",
"6p6c",
"6p4c",
"6p2c",
"4p4c",
"4p2c",
"gg45",
"tera-4p",
"tera-2p",
"tera-1p",
"110-punch",
"bnc",
"f",
"n",
"mrj21",
"fc",
"fc-pc",
"fc-upc",
"fc-apc",
"lc",
"lc-pc",
"lc-upc",
"lc-apc",
"lsh",
"lsh-pc",
"lsh-upc",
"lsh-apc",
"lx5",
"lx5-pc",
"lx5-upc",
"lx5-apc",
"mpo",
"mtrj",
"sc",
"sc-pc",
"sc-upc",
"sc-apc",
"st",
"cs",
"sn",
"sma-905",
"sma-906",
"urm-p2",
"urm-p4",
"urm-p8",
"splice",
"usb-a",
"usb-b",
"usb-c",
"usb-mini-a",
"usb-mini-b",
"usb-micro-a",
"usb-micro-b",
"usb-micro-ab",
"other"
],
"type": "string",
"description": "* `8p8c` - 8P8C\n* `8p6c` - 8P6C\n* `8p4c` - 8P4C\n* `8p2c` - 8P2C\n* `6p6c` - 6P6C\n* `6p4c` - 6P4C\n* `6p2c` - 6P2C\n* `4p4c` - 4P4C\n* `4p2c` - 4P2C\n* `gg45` - GG45\n* `tera-4p` - TERA 4P\n* `tera-2p` - TERA 2P\n* `tera-1p` - TERA 1P\n* `110-punch` - 110 Punch\n* `bnc` - BNC\n* `f` - F Connector\n* `n` - N Connector\n* `mrj21` - MRJ21\n* `fc` - FC\n* `fc-pc` - FC/PC\n* `fc-upc` - FC/UPC\n* `fc-apc` - FC/APC\n* `lc` - LC\n* `lc-pc` - LC/PC\n* `lc-upc` - LC/UPC\n* `lc-apc` - LC/APC\n* `lsh` - LSH\n* `lsh-pc` - LSH/PC\n* `lsh-upc` - LSH/UPC\n* `lsh-apc` - LSH/APC\n* `lx5` - LX.5\n* `lx5-pc` - LX.5/PC\n* `lx5-upc` - LX.5/UPC\n* `lx5-apc` - LX.5/APC\n* `mpo` - MPO\n* `mtrj` - MTRJ\n* `sc` - SC\n* `sc-pc` - SC/PC\n* `sc-upc` - SC/UPC\n* `sc-apc` - SC/APC\n* `st` - ST\n* `cs` - CS\n* `sn` - SN\n* `sma-905` - SMA 905\n* `sma-906` - SMA 906\n* `urm-p2` - URM-P2\n* `urm-p4` - URM-P4\n* `urm-p8` - URM-P8\n* `splice` - Splice\n* `usb-a` - USB Type A\n* `usb-b` - USB Type B\n* `usb-c` - USB Type C\n* `usb-mini-a` - USB Mini A\n* `usb-mini-b` - USB Mini B\n* `usb-micro-a` - USB Micro A\n* `usb-micro-b` - USB Micro B\n* `usb-micro-ab` - USB Micro AB\n* `other` - Other",
"x-spec-enum-id": "ea67ae8ba4602f8a"
},
"label": {
"type": "string",
"enum": [
"8P8C",
"8P6C",
"8P4C",
"8P2C",
"6P6C",
"6P4C",
"6P2C",
"4P4C",
"4P2C",
"GG45",
"TERA 4P",
"TERA 2P",
"TERA 1P",
"110 Punch",
"BNC",
"F Connector",
"N Connector",
"MRJ21",
"FC",
"FC/PC",
"FC/UPC",
"FC/APC",
"LC",
"LC/PC",
"LC/UPC",
"LC/APC",
"LSH",
"LSH/PC",
"LSH/UPC",
"LSH/APC",
"LX.5",
"LX.5/PC",
"LX.5/UPC",
"LX.5/APC",
"MPO",
"MTRJ",
"SC",
"SC/PC",
"SC/UPC",
"SC/APC",
"ST",
"CS",
"SN",
"SMA 905",
"SMA 906",
"URM-P2",
"URM-P4",
"URM-P8",
"Splice",
"USB Type A",
"USB Type B",
"USB Type C",
"USB Mini A",
"USB Mini B",
"USB Micro A",
"USB Micro B",
"USB Micro AB",
"Other"
]
}
}
},
"color": {
"type": "string",
"pattern": "^[0-9a-f]{6}$",
"maxLength": 6
},
"positions": {
"type": "integer",
"maximum": 1024,
"minimum": 1,
"description": "Number of front ports which may be mapped"
},
"description": {
"type": "string",
"maxLength": 200
},
"mark_connected": {
"type": "boolean",
"description": "Treat as if a cable is connected"
},
"cable": {
"allOf": [
{
"$ref": "#/components/schemas/BriefCable"
}
],
"readOnly": true,
"nullable": true
},
"cable_end": {
"type": "string",
"readOnly": true
},
"link_peers": {
"type": "array",
"items": {},
"readOnly": true
},
"link_peers_type": {
"type": "string",
"description": "Return the type of the peer link terminations, or None.",
"readOnly": true,
"nullable": true
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"_occupied": {
"type": "boolean",
"readOnly": true,
"title": " occupied"
}
},
"required": [
"_occupied",
"cable",
"cable_end",
"created",
"device",
"display",
"display_url",
"id",
"last_updated",
"link_peers",
"link_peers_type",
"name",
"type",
"url"
]
},
"RearPortRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"device": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDeviceRequest"
}
]
},
"module": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"enum": [
"8p8c",
"8p6c",
"8p4c",
"8p2c",
"6p6c",
"6p4c",
"6p2c",
"4p4c",
"4p2c",
"gg45",
"tera-4p",
"tera-2p",
"tera-1p",
"110-punch",
"bnc",
"f",
"n",
"mrj21",
"fc",
"fc-pc",
"fc-upc",
"fc-apc",
"lc",
"lc-pc",
"lc-upc",
"lc-apc",
"lsh",
"lsh-pc",
"lsh-upc",
"lsh-apc",
"lx5",
"lx5-pc",
"lx5-upc",
"lx5-apc",
"mpo",
"mtrj",
"sc",
"sc-pc",
"sc-upc",
"sc-apc",
"st",
"cs",
"sn",
"sma-905",
"sma-906",
"urm-p2",
"urm-p4",
"urm-p8",
"splice",
"usb-a",
"usb-b",
"usb-c",
"usb-mini-a",
"usb-mini-b",
"usb-micro-a",
"usb-micro-b",
"usb-micro-ab",
"other"
],
"type": "string",
"description": "* `8p8c` - 8P8C\n* `8p6c` - 8P6C\n* `8p4c` - 8P4C\n* `8p2c` - 8P2C\n* `6p6c` - 6P6C\n* `6p4c` - 6P4C\n* `6p2c` - 6P2C\n* `4p4c` - 4P4C\n* `4p2c` - 4P2C\n* `gg45` - GG45\n* `tera-4p` - TERA 4P\n* `tera-2p` - TERA 2P\n* `tera-1p` - TERA 1P\n* `110-punch` - 110 Punch\n* `bnc` - BNC\n* `f` - F Connector\n* `n` - N Connector\n* `mrj21` - MRJ21\n* `fc` - FC\n* `fc-pc` - FC/PC\n* `fc-upc` - FC/UPC\n* `fc-apc` - FC/APC\n* `lc` - LC\n* `lc-pc` - LC/PC\n* `lc-upc` - LC/UPC\n* `lc-apc` - LC/APC\n* `lsh` - LSH\n* `lsh-pc` - LSH/PC\n* `lsh-upc` - LSH/UPC\n* `lsh-apc` - LSH/APC\n* `lx5` - LX.5\n* `lx5-pc` - LX.5/PC\n* `lx5-upc` - LX.5/UPC\n* `lx5-apc` - LX.5/APC\n* `mpo` - MPO\n* `mtrj` - MTRJ\n* `sc` - SC\n* `sc-pc` - SC/PC\n* `sc-upc` - SC/UPC\n* `sc-apc` - SC/APC\n* `st` - ST\n* `cs` - CS\n* `sn` - SN\n* `sma-905` - SMA 905\n* `sma-906` - SMA 906\n* `urm-p2` - URM-P2\n* `urm-p4` - URM-P4\n* `urm-p8` - URM-P8\n* `splice` - Splice\n* `usb-a` - USB Type A\n* `usb-b` - USB Type B\n* `usb-c` - USB Type C\n* `usb-mini-a` - USB Mini A\n* `usb-mini-b` - USB Mini B\n* `usb-micro-a` - USB Micro A\n* `usb-micro-b` - USB Micro B\n* `usb-micro-ab` - USB Micro AB\n* `other` - Other",
"x-spec-enum-id": "ea67ae8ba4602f8a"
},
"color": {
"type": "string",
"pattern": "^[0-9a-f]{6}$",
"maxLength": 6
},
"positions": {
"type": "integer",
"maximum": 1024,
"minimum": 1,
"description": "Number of front ports which may be mapped"
},
"description": {
"type": "string",
"maxLength": 200
},
"mark_connected": {
"type": "boolean",
"description": "Treat as if a cable is connected"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"device",
"name",
"type"
]
},
"RearPortTemplate": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"device_type": {
"allOf": [
{
"$ref": "#/components/schemas/BriefDeviceType"
}
],
"nullable": true
},
"module_type": {
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleType"
}
],
"nullable": true
},
"name": {
"type": "string",
"description": "{module} is accepted as a substitution for the module bay position when attached to a module type.",
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"type": "object",
"properties": {
"value": {
"enum": [
"8p8c",
"8p6c",
"8p4c",
"8p2c",
"6p6c",
"6p4c",
"6p2c",
"4p4c",
"4p2c",
"gg45",
"tera-4p",
"tera-2p",
"tera-1p",
"110-punch",
"bnc",
"f",
"n",
"mrj21",
"fc",
"fc-pc",
"fc-upc",
"fc-apc",
"lc",
"lc-pc",
"lc-upc",
"lc-apc",
"lsh",
"lsh-pc",
"lsh-upc",
"lsh-apc",
"lx5",
"lx5-pc",
"lx5-upc",
"lx5-apc",
"mpo",
"mtrj",
"sc",
"sc-pc",
"sc-upc",
"sc-apc",
"st",
"cs",
"sn",
"sma-905",
"sma-906",
"urm-p2",
"urm-p4",
"urm-p8",
"splice",
"usb-a",
"usb-b",
"usb-c",
"usb-mini-a",
"usb-mini-b",
"usb-micro-a",
"usb-micro-b",
"usb-micro-ab",
"other"
],
"type": "string",
"description": "* `8p8c` - 8P8C\n* `8p6c` - 8P6C\n* `8p4c` - 8P4C\n* `8p2c` - 8P2C\n* `6p6c` - 6P6C\n* `6p4c` - 6P4C\n* `6p2c` - 6P2C\n* `4p4c` - 4P4C\n* `4p2c` - 4P2C\n* `gg45` - GG45\n* `tera-4p` - TERA 4P\n* `tera-2p` - TERA 2P\n* `tera-1p` - TERA 1P\n* `110-punch` - 110 Punch\n* `bnc` - BNC\n* `f` - F Connector\n* `n` - N Connector\n* `mrj21` - MRJ21\n* `fc` - FC\n* `fc-pc` - FC/PC\n* `fc-upc` - FC/UPC\n* `fc-apc` - FC/APC\n* `lc` - LC\n* `lc-pc` - LC/PC\n* `lc-upc` - LC/UPC\n* `lc-apc` - LC/APC\n* `lsh` - LSH\n* `lsh-pc` - LSH/PC\n* `lsh-upc` - LSH/UPC\n* `lsh-apc` - LSH/APC\n* `lx5` - LX.5\n* `lx5-pc` - LX.5/PC\n* `lx5-upc` - LX.5/UPC\n* `lx5-apc` - LX.5/APC\n* `mpo` - MPO\n* `mtrj` - MTRJ\n* `sc` - SC\n* `sc-pc` - SC/PC\n* `sc-upc` - SC/UPC\n* `sc-apc` - SC/APC\n* `st` - ST\n* `cs` - CS\n* `sn` - SN\n* `sma-905` - SMA 905\n* `sma-906` - SMA 906\n* `urm-p2` - URM-P2\n* `urm-p4` - URM-P4\n* `urm-p8` - URM-P8\n* `splice` - Splice\n* `usb-a` - USB Type A\n* `usb-b` - USB Type B\n* `usb-c` - USB Type C\n* `usb-mini-a` - USB Mini A\n* `usb-mini-b` - USB Mini B\n* `usb-micro-a` - USB Micro A\n* `usb-micro-b` - USB Micro B\n* `usb-micro-ab` - USB Micro AB\n* `other` - Other",
"x-spec-enum-id": "ea67ae8ba4602f8a"
},
"label": {
"type": "string",
"enum": [
"8P8C",
"8P6C",
"8P4C",
"8P2C",
"6P6C",
"6P4C",
"6P2C",
"4P4C",
"4P2C",
"GG45",
"TERA 4P",
"TERA 2P",
"TERA 1P",
"110 Punch",
"BNC",
"F Connector",
"N Connector",
"MRJ21",
"FC",
"FC/PC",
"FC/UPC",
"FC/APC",
"LC",
"LC/PC",
"LC/UPC",
"LC/APC",
"LSH",
"LSH/PC",
"LSH/UPC",
"LSH/APC",
"LX.5",
"LX.5/PC",
"LX.5/UPC",
"LX.5/APC",
"MPO",
"MTRJ",
"SC",
"SC/PC",
"SC/UPC",
"SC/APC",
"ST",
"CS",
"SN",
"SMA 905",
"SMA 906",
"URM-P2",
"URM-P4",
"URM-P8",
"Splice",
"USB Type A",
"USB Type B",
"USB Type C",
"USB Mini A",
"USB Mini B",
"USB Micro A",
"USB Micro B",
"USB Micro AB",
"Other"
]
}
}
},
"color": {
"type": "string",
"pattern": "^[0-9a-f]{6}$",
"maxLength": 6
},
"positions": {
"type": "integer",
"maximum": 1024,
"minimum": 1
},
"description": {
"type": "string",
"maxLength": 200
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"created",
"display",
"id",
"last_updated",
"name",
"type",
"url"
]
},
"RearPortTemplateRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"device_type": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefDeviceTypeRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"module_type": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleTypeRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"description": "{module} is accepted as a substitution for the module bay position when attached to a module type.",
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"enum": [
"8p8c",
"8p6c",
"8p4c",
"8p2c",
"6p6c",
"6p4c",
"6p2c",
"4p4c",
"4p2c",
"gg45",
"tera-4p",
"tera-2p",
"tera-1p",
"110-punch",
"bnc",
"f",
"n",
"mrj21",
"fc",
"fc-pc",
"fc-upc",
"fc-apc",
"lc",
"lc-pc",
"lc-upc",
"lc-apc",
"lsh",
"lsh-pc",
"lsh-upc",
"lsh-apc",
"lx5",
"lx5-pc",
"lx5-upc",
"lx5-apc",
"mpo",
"mtrj",
"sc",
"sc-pc",
"sc-upc",
"sc-apc",
"st",
"cs",
"sn",
"sma-905",
"sma-906",
"urm-p2",
"urm-p4",
"urm-p8",
"splice",
"usb-a",
"usb-b",
"usb-c",
"usb-mini-a",
"usb-mini-b",
"usb-micro-a",
"usb-micro-b",
"usb-micro-ab",
"other"
],
"type": "string",
"description": "* `8p8c` - 8P8C\n* `8p6c` - 8P6C\n* `8p4c` - 8P4C\n* `8p2c` - 8P2C\n* `6p6c` - 6P6C\n* `6p4c` - 6P4C\n* `6p2c` - 6P2C\n* `4p4c` - 4P4C\n* `4p2c` - 4P2C\n* `gg45` - GG45\n* `tera-4p` - TERA 4P\n* `tera-2p` - TERA 2P\n* `tera-1p` - TERA 1P\n* `110-punch` - 110 Punch\n* `bnc` - BNC\n* `f` - F Connector\n* `n` - N Connector\n* `mrj21` - MRJ21\n* `fc` - FC\n* `fc-pc` - FC/PC\n* `fc-upc` - FC/UPC\n* `fc-apc` - FC/APC\n* `lc` - LC\n* `lc-pc` - LC/PC\n* `lc-upc` - LC/UPC\n* `lc-apc` - LC/APC\n* `lsh` - LSH\n* `lsh-pc` - LSH/PC\n* `lsh-upc` - LSH/UPC\n* `lsh-apc` - LSH/APC\n* `lx5` - LX.5\n* `lx5-pc` - LX.5/PC\n* `lx5-upc` - LX.5/UPC\n* `lx5-apc` - LX.5/APC\n* `mpo` - MPO\n* `mtrj` - MTRJ\n* `sc` - SC\n* `sc-pc` - SC/PC\n* `sc-upc` - SC/UPC\n* `sc-apc` - SC/APC\n* `st` - ST\n* `cs` - CS\n* `sn` - SN\n* `sma-905` - SMA 905\n* `sma-906` - SMA 906\n* `urm-p2` - URM-P2\n* `urm-p4` - URM-P4\n* `urm-p8` - URM-P8\n* `splice` - Splice\n* `usb-a` - USB Type A\n* `usb-b` - USB Type B\n* `usb-c` - USB Type C\n* `usb-mini-a` - USB Mini A\n* `usb-mini-b` - USB Mini B\n* `usb-micro-a` - USB Micro A\n* `usb-micro-b` - USB Micro B\n* `usb-micro-ab` - USB Micro AB\n* `other` - Other",
"x-spec-enum-id": "ea67ae8ba4602f8a"
},
"color": {
"type": "string",
"pattern": "^[0-9a-f]{6}$",
"maxLength": 6
},
"positions": {
"type": "integer",
"maximum": 1024,
"minimum": 1
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name",
"type"
]
},
"Region": {
"type": "object",
"description": "Extends PrimaryModelSerializer to include MPTT support.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"parent": {
"allOf": [
{
"$ref": "#/components/schemas/NestedRegion"
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"site_count": {
"type": "integer",
"readOnly": true,
"default": 0
},
"prefix_count": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"comments": {
"type": "string"
},
"_depth": {
"type": "integer",
"readOnly": true,
"title": " depth"
}
},
"required": [
"_depth",
"created",
"display",
"display_url",
"id",
"last_updated",
"name",
"prefix_count",
"site_count",
"slug",
"url"
]
},
"RegionRequest": {
"type": "object",
"description": "Extends PrimaryModelSerializer to include MPTT support.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"parent": {
"allOf": [
{
"$ref": "#/components/schemas/NestedRegionRequest"
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"comments": {
"type": "string"
}
},
"required": [
"name",
"slug"
]
},
"Role": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"weight": {
"type": "integer",
"maximum": 32767,
"minimum": 0
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"prefix_count": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"vlan_count": {
"type": "integer",
"format": "int64",
"readOnly": true
}
},
"required": [
"created",
"display",
"display_url",
"id",
"last_updated",
"name",
"prefix_count",
"slug",
"url",
"vlan_count"
]
},
"RoleRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"weight": {
"type": "integer",
"maximum": 32767,
"minimum": 0
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name",
"slug"
]
},
"RouteTarget": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"description": "Route target value (formatted in accordance with RFC 4360)",
"maxLength": 21
},
"tenant": {
"allOf": [
{
"$ref": "#/components/schemas/BriefTenant"
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"created",
"display",
"display_url",
"id",
"last_updated",
"name",
"url"
]
},
"RouteTargetRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"description": "Route target value (formatted in accordance with RFC 4360)",
"maxLength": 21
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name"
]
},
"SavedFilter": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"object_types": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
},
"user": {
"type": "integer",
"nullable": true
},
"weight": {
"type": "integer",
"maximum": 32767,
"minimum": 0
},
"enabled": {
"type": "boolean"
},
"shared": {
"type": "boolean"
},
"parameters": {},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"created",
"display",
"display_url",
"id",
"last_updated",
"name",
"object_types",
"parameters",
"slug",
"url"
]
},
"SavedFilterRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"object_types": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
},
"user": {
"type": "integer",
"nullable": true
},
"weight": {
"type": "integer",
"maximum": 32767,
"minimum": 0
},
"enabled": {
"type": "boolean"
},
"shared": {
"type": "boolean"
},
"parameters": {}
},
"required": [
"name",
"object_types",
"parameters",
"slug"
]
},
"Script": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"module": {
"type": "integer",
"readOnly": true
},
"name": {
"type": "string",
"readOnly": true
},
"description": {
"type": "string",
"nullable": true,
"readOnly": true
},
"vars": {
"nullable": true,
"readOnly": true
},
"result": {
"allOf": [
{
"$ref": "#/components/schemas/BriefJob"
}
],
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"is_executable": {
"type": "boolean",
"readOnly": true
}
},
"required": [
"description",
"display",
"display_url",
"id",
"is_executable",
"module",
"name",
"result",
"url",
"vars"
]
},
"ScriptInputRequest": {
"type": "object",
"properties": {
"data": {},
"commit": {
"type": "boolean"
},
"schedule_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
"interval": {
"type": "integer",
"nullable": true
}
},
"required": [
"commit",
"data"
]
},
"Service": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"parent_object_type": {
"type": "string"
},
"parent_object_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64"
},
"parent": {
"nullable": true,
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"protocol": {
"type": "object",
"properties": {
"value": {
"enum": [
"tcp",
"udp",
"sctp"
],
"type": "string",
"description": "* `tcp` - TCP\n* `udp` - UDP\n* `sctp` - SCTP",
"x-spec-enum-id": "5521e084b1ad51de"
},
"label": {
"type": "string",
"enum": [
"TCP",
"UDP",
"SCTP"
]
}
}
},
"ports": {
"type": "array",
"items": {
"type": "integer",
"maximum": 65535,
"minimum": 1
},
"title": "Port numbers"
},
"ipaddresses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IPAddress"
}
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"created",
"display",
"display_url",
"id",
"last_updated",
"name",
"parent",
"parent_object_id",
"parent_object_type",
"ports",
"url"
]
},
"ServiceRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"parent_object_type": {
"type": "string"
},
"parent_object_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"protocol": {
"enum": [
"tcp",
"udp",
"sctp"
],
"type": "string",
"description": "* `tcp` - TCP\n* `udp` - UDP\n* `sctp` - SCTP",
"x-spec-enum-id": "5521e084b1ad51de"
},
"ports": {
"type": "array",
"items": {
"type": "integer",
"maximum": 65535,
"minimum": 1
},
"title": "Port numbers"
},
"ipaddresses": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name",
"parent_object_id",
"parent_object_type",
"ports"
]
},
"ServiceTemplate": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"protocol": {
"type": "object",
"properties": {
"value": {
"enum": [
"tcp",
"udp",
"sctp"
],
"type": "string",
"description": "* `tcp` - TCP\n* `udp` - UDP\n* `sctp` - SCTP",
"x-spec-enum-id": "5521e084b1ad51de"
},
"label": {
"type": "string",
"enum": [
"TCP",
"UDP",
"SCTP"
]
}
}
},
"ports": {
"type": "array",
"items": {
"type": "integer",
"maximum": 65535,
"minimum": 1
},
"title": "Port numbers"
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"created",
"display",
"display_url",
"id",
"last_updated",
"name",
"ports",
"url"
]
},
"ServiceTemplateRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"protocol": {
"enum": [
"tcp",
"udp",
"sctp"
],
"type": "string",
"description": "* `tcp` - TCP\n* `udp` - UDP\n* `sctp` - SCTP",
"x-spec-enum-id": "5521e084b1ad51de"
},
"ports": {
"type": "array",
"items": {
"type": "integer",
"maximum": 65535,
"minimum": 1
},
"title": "Port numbers"
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name",
"ports"
]
},
"Site": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"description": "Full name of the site",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"status": {
"type": "object",
"properties": {
"value": {
"enum": [
"planned",
"staging",
"active",
"decommissioning",
"retired"
],
"type": "string",
"description": "* `planned` - Planned\n* `staging` - Staging\n* `active` - Active\n* `decommissioning` - Decommissioning\n* `retired` - Retired",
"x-spec-enum-id": "e363a8ddb138be50"
},
"label": {
"type": "string",
"enum": [
"Planned",
"Staging",
"Active",
"Decommissioning",
"Retired"
]
}
}
},
"region": {
"allOf": [
{
"$ref": "#/components/schemas/BriefRegion"
}
],
"nullable": true
},
"group": {
"allOf": [
{
"$ref": "#/components/schemas/BriefSiteGroup"
}
],
"nullable": true
},
"tenant": {
"allOf": [
{
"$ref": "#/components/schemas/BriefTenant"
}
],
"nullable": true
},
"facility": {
"type": "string",
"description": "Local facility ID or description",
"maxLength": 50
},
"time_zone": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"physical_address": {
"type": "string",
"description": "Physical location of the building",
"maxLength": 200
},
"shipping_address": {
"type": "string",
"description": "If different from the physical address",
"maxLength": 200
},
"latitude": {
"type": "number",
"format": "double",
"maximum": 100,
"minimum": -100,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true,
"description": "GPS coordinate in decimal format (xx.yyyyyy)"
},
"longitude": {
"type": "number",
"format": "double",
"maximum": 1000,
"minimum": -1000,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true,
"description": "GPS coordinate in decimal format (xx.yyyyyy)"
},
"comments": {
"type": "string"
},
"asns": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ASN"
}
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"circuit_count": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"device_count": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"prefix_count": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"rack_count": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"virtualmachine_count": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"vlan_count": {
"type": "integer",
"format": "int64",
"readOnly": true
}
},
"required": [
"circuit_count",
"created",
"device_count",
"display",
"display_url",
"id",
"last_updated",
"name",
"prefix_count",
"rack_count",
"slug",
"url",
"virtualmachine_count",
"vlan_count"
]
},
"SiteGroup": {
"type": "object",
"description": "Extends PrimaryModelSerializer to include MPTT support.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"parent": {
"allOf": [
{
"$ref": "#/components/schemas/NestedSiteGroup"
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"site_count": {
"type": "integer",
"readOnly": true,
"default": 0
},
"prefix_count": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"comments": {
"type": "string"
},
"_depth": {
"type": "integer",
"readOnly": true,
"title": " depth"
}
},
"required": [
"_depth",
"created",
"display",
"display_url",
"id",
"last_updated",
"name",
"prefix_count",
"site_count",
"slug",
"url"
]
},
"SiteGroupRequest": {
"type": "object",
"description": "Extends PrimaryModelSerializer to include MPTT support.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"parent": {
"allOf": [
{
"$ref": "#/components/schemas/NestedSiteGroupRequest"
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"comments": {
"type": "string"
}
},
"required": [
"name",
"slug"
]
},
"SiteRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"description": "Full name of the site",
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"status": {
"enum": [
"planned",
"staging",
"active",
"decommissioning",
"retired"
],
"type": "string",
"description": "* `planned` - Planned\n* `staging` - Staging\n* `active` - Active\n* `decommissioning` - Decommissioning\n* `retired` - Retired",
"x-spec-enum-id": "e363a8ddb138be50"
},
"region": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefRegionRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"group": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefSiteGroupRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"facility": {
"type": "string",
"description": "Local facility ID or description",
"maxLength": 50
},
"time_zone": {
"type": "string",
"nullable": true,
"minLength": 1
},
"description": {
"type": "string",
"maxLength": 200
},
"physical_address": {
"type": "string",
"description": "Physical location of the building",
"maxLength": 200
},
"shipping_address": {
"type": "string",
"description": "If different from the physical address",
"maxLength": 200
},
"latitude": {
"type": "number",
"format": "double",
"maximum": 100,
"minimum": -100,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true,
"description": "GPS coordinate in decimal format (xx.yyyyyy)"
},
"longitude": {
"type": "number",
"format": "double",
"maximum": 1000,
"minimum": -1000,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true,
"description": "GPS coordinate in decimal format (xx.yyyyyy)"
},
"comments": {
"type": "string"
},
"asns": {
"type": "array",
"items": {
"type": "integer"
}
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name",
"slug"
]
},
"Subscription": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"object_type": {
"type": "string"
},
"object_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64"
},
"object": {
"nullable": true,
"readOnly": true
},
"user": {
"$ref": "#/components/schemas/BriefUser"
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true
}
},
"required": [
"created",
"display",
"id",
"object",
"object_id",
"object_type",
"url",
"user"
]
},
"SubscriptionRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"object_type": {
"type": "string"
},
"object_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64"
},
"user": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefUserRequest"
}
]
}
},
"required": [
"object_id",
"object_type",
"user"
]
},
"TableConfig": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"object_type": {
"type": "string"
},
"table": {
"type": "string",
"maxLength": 100
},
"name": {
"type": "string",
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"user": {
"type": "integer",
"nullable": true
},
"weight": {
"type": "integer",
"maximum": 32767,
"minimum": 0
},
"enabled": {
"type": "boolean"
},
"shared": {
"type": "boolean"
},
"columns": {
"type": "array",
"items": {
"type": "string",
"maxLength": 100
}
},
"ordering": {
"type": "array",
"items": {
"type": "string",
"maxLength": 100
},
"nullable": true
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"columns",
"created",
"display",
"display_url",
"id",
"last_updated",
"name",
"object_type",
"table",
"url"
]
},
"TableConfigRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"object_type": {
"type": "string"
},
"table": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"user": {
"type": "integer",
"nullable": true
},
"weight": {
"type": "integer",
"maximum": 32767,
"minimum": 0
},
"enabled": {
"type": "boolean"
},
"shared": {
"type": "boolean"
},
"columns": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
}
},
"ordering": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"nullable": true
}
},
"required": [
"columns",
"name",
"object_type",
"table"
]
},
"Tag": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"pattern": "^[-\\w]+$",
"maxLength": 100
},
"color": {
"type": "string",
"pattern": "^[0-9a-f]{6}$",
"maxLength": 6
},
"description": {
"type": "string",
"maxLength": 200
},
"weight": {
"type": "integer",
"maximum": 32767,
"minimum": 0
},
"object_types": {
"type": "array",
"items": {
"type": "string"
}
},
"tagged_items": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"created",
"display",
"display_url",
"id",
"last_updated",
"name",
"slug",
"tagged_items",
"url"
]
},
"TagRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"pattern": "^[-\\w]+$",
"maxLength": 100
},
"color": {
"type": "string",
"minLength": 1,
"pattern": "^[0-9a-f]{6}$",
"maxLength": 6
},
"description": {
"type": "string",
"maxLength": 200
},
"weight": {
"type": "integer",
"maximum": 32767,
"minimum": 0
},
"object_types": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"name",
"slug"
]
},
"TaggedItem": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"object_type": {
"type": "string",
"readOnly": true
},
"object_id": {
"type": "integer",
"maximum": 2147483647,
"minimum": -2147483648
},
"object": {
"readOnly": true
},
"tag": {
"allOf": [
{
"$ref": "#/components/schemas/BriefTag"
}
],
"readOnly": true
}
},
"required": [
"display",
"id",
"object",
"object_id",
"object_type",
"tag",
"url"
]
},
"Tenant": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"group": {
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantGroup"
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"circuit_count": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"device_count": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"ipaddress_count": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"prefix_count": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"rack_count": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"site_count": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"virtualmachine_count": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"vlan_count": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"vrf_count": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"cluster_count": {
"type": "integer",
"format": "int64",
"readOnly": true
}
},
"required": [
"circuit_count",
"cluster_count",
"created",
"device_count",
"display",
"display_url",
"id",
"ipaddress_count",
"last_updated",
"name",
"prefix_count",
"rack_count",
"site_count",
"slug",
"url",
"virtualmachine_count",
"vlan_count",
"vrf_count"
]
},
"TenantGroup": {
"type": "object",
"description": "Extends PrimaryModelSerializer to include MPTT support.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"parent": {
"allOf": [
{
"$ref": "#/components/schemas/NestedTenantGroup"
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"tenant_count": {
"type": "integer",
"readOnly": true,
"default": 0
},
"comments": {
"type": "string"
},
"_depth": {
"type": "integer",
"readOnly": true,
"title": " depth"
}
},
"required": [
"_depth",
"created",
"display",
"display_url",
"id",
"last_updated",
"name",
"slug",
"tenant_count",
"url"
]
},
"TenantGroupRequest": {
"type": "object",
"description": "Extends PrimaryModelSerializer to include MPTT support.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"parent": {
"allOf": [
{
"$ref": "#/components/schemas/NestedTenantGroupRequest"
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"comments": {
"type": "string"
}
},
"required": [
"name",
"slug"
]
},
"TenantRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"group": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantGroupRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name",
"slug"
]
},
"Token": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"user": {
"$ref": "#/components/schemas/BriefUser"
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"expires": {
"type": "string",
"format": "date-time",
"nullable": true
},
"last_used": {
"type": "string",
"format": "date-time",
"nullable": true
},
"write_enabled": {
"type": "boolean",
"description": "Permit create/update/delete operations using this key"
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"created",
"display",
"display_url",
"id",
"url",
"user"
]
},
"TokenProvision": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"user": {
"allOf": [
{
"$ref": "#/components/schemas/BriefUser"
}
],
"readOnly": true
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"expires": {
"type": "string",
"format": "date-time",
"nullable": true
},
"last_used": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"key": {
"type": "string",
"readOnly": true
},
"write_enabled": {
"type": "boolean",
"description": "Permit create/update/delete operations using this key"
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"created",
"display",
"display_url",
"id",
"key",
"last_used",
"url",
"user"
]
},
"TokenProvisionRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"expires": {
"type": "string",
"format": "date-time",
"nullable": true
},
"write_enabled": {
"type": "boolean",
"description": "Permit create/update/delete operations using this key"
},
"description": {
"type": "string",
"maxLength": 200
},
"username": {
"type": "string",
"writeOnly": true,
"minLength": 1
},
"password": {
"type": "string",
"writeOnly": true,
"minLength": 1
}
},
"required": [
"password",
"username"
]
},
"TokenRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"user": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefUserRequest"
}
]
},
"expires": {
"type": "string",
"format": "date-time",
"nullable": true
},
"last_used": {
"type": "string",
"format": "date-time",
"nullable": true
},
"key": {
"type": "string",
"writeOnly": true,
"maxLength": 40,
"minLength": 40
},
"write_enabled": {
"type": "boolean",
"description": "Permit create/update/delete operations using this key"
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"user"
]
},
"Tunnel": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"status": {
"type": "object",
"properties": {
"value": {
"enum": [
"planned",
"active",
"disabled"
],
"type": "string",
"description": "* `planned` - Planned\n* `active` - Active\n* `disabled` - Disabled",
"x-spec-enum-id": "0d65f7912cba74aa"
},
"label": {
"type": "string",
"enum": [
"Planned",
"Active",
"Disabled"
]
}
}
},
"group": {
"allOf": [
{
"$ref": "#/components/schemas/BriefTunnelGroup"
}
],
"nullable": true
},
"encapsulation": {
"type": "object",
"properties": {
"value": {
"enum": [
"ipsec-transport",
"ipsec-tunnel",
"ip-ip",
"gre",
"wireguard",
"openvpn",
"l2tp",
"pptp"
],
"type": "string",
"description": "* `ipsec-transport` - IPsec - Transport\n* `ipsec-tunnel` - IPsec - Tunnel\n* `ip-ip` - IP-in-IP\n* `gre` - GRE\n* `wireguard` - WireGuard\n* `openvpn` - OpenVPN\n* `l2tp` - L2TP\n* `pptp` - PPTP",
"x-spec-enum-id": "54a2e45824009c49"
},
"label": {
"type": "string",
"enum": [
"IPsec - Transport",
"IPsec - Tunnel",
"IP-in-IP",
"GRE",
"WireGuard",
"OpenVPN",
"L2TP",
"PPTP"
]
}
}
},
"ipsec_profile": {
"allOf": [
{
"$ref": "#/components/schemas/BriefIPSecProfile"
}
],
"nullable": true
},
"tenant": {
"allOf": [
{
"$ref": "#/components/schemas/BriefTenant"
}
],
"nullable": true
},
"tunnel_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"terminations_count": {
"type": "integer",
"format": "int64",
"readOnly": true
}
},
"required": [
"created",
"display",
"display_url",
"encapsulation",
"id",
"last_updated",
"name",
"status",
"terminations_count",
"url"
]
},
"TunnelGroup": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"tunnel_count": {
"type": "integer",
"format": "int64",
"readOnly": true
}
},
"required": [
"created",
"display",
"display_url",
"id",
"last_updated",
"name",
"slug",
"tunnel_count",
"url"
]
},
"TunnelGroupRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name",
"slug"
]
},
"TunnelRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"status": {
"enum": [
"planned",
"active",
"disabled"
],
"type": "string",
"description": "* `planned` - Planned\n* `active` - Active\n* `disabled` - Disabled",
"x-spec-enum-id": "0d65f7912cba74aa"
},
"group": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTunnelGroupRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"encapsulation": {
"enum": [
"ipsec-transport",
"ipsec-tunnel",
"ip-ip",
"gre",
"wireguard",
"openvpn",
"l2tp",
"pptp"
],
"type": "string",
"description": "* `ipsec-transport` - IPsec - Transport\n* `ipsec-tunnel` - IPsec - Tunnel\n* `ip-ip` - IP-in-IP\n* `gre` - GRE\n* `wireguard` - WireGuard\n* `openvpn` - OpenVPN\n* `l2tp` - L2TP\n* `pptp` - PPTP",
"x-spec-enum-id": "54a2e45824009c49"
},
"ipsec_profile": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefIPSecProfileRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"tunnel_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"encapsulation",
"name",
"status"
]
},
"TunnelTermination": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"tunnel": {
"$ref": "#/components/schemas/BriefTunnel"
},
"role": {
"type": "object",
"properties": {
"value": {
"enum": [
"peer",
"hub",
"spoke"
],
"type": "string",
"description": "* `peer` - Peer\n* `hub` - Hub\n* `spoke` - Spoke",
"x-spec-enum-id": "52225cd60b867572"
},
"label": {
"type": "string",
"enum": [
"Peer",
"Hub",
"Spoke"
]
}
}
},
"termination_type": {
"type": "string"
},
"termination_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64",
"nullable": true
},
"termination": {
"nullable": true,
"readOnly": true
},
"outside_ip": {
"allOf": [
{
"$ref": "#/components/schemas/BriefIPAddress"
}
],
"nullable": true
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"created",
"display",
"display_url",
"id",
"last_updated",
"role",
"termination",
"termination_type",
"tunnel",
"url"
]
},
"TunnelTerminationRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"tunnel": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefTunnelRequest"
}
]
},
"role": {
"enum": [
"peer",
"hub",
"spoke"
],
"type": "string",
"description": "* `peer` - Peer\n* `hub` - Hub\n* `spoke` - Spoke",
"x-spec-enum-id": "52225cd60b867572"
},
"termination_type": {
"type": "string"
},
"termination_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64",
"nullable": true
},
"outside_ip": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefIPAddressRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"role",
"termination_type",
"tunnel"
]
},
"User": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"username": {
"type": "string",
"description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
"pattern": "^[\\w.@+-]+$",
"maxLength": 150
},
"first_name": {
"type": "string",
"maxLength": 150
},
"last_name": {
"type": "string",
"maxLength": 150
},
"email": {
"type": "string",
"format": "email",
"title": "Email address",
"maxLength": 254
},
"is_staff": {
"type": "boolean",
"title": "Staff status",
"description": "Designates whether the user can log into this admin site."
},
"is_active": {
"type": "boolean",
"title": "Active",
"description": "Designates whether this user should be treated as active. Unselect this instead of deleting accounts."
},
"date_joined": {
"type": "string",
"format": "date-time"
},
"last_login": {
"type": "string",
"format": "date-time",
"nullable": true
},
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Group"
}
},
"permissions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ObjectPermission"
}
}
},
"required": [
"display",
"display_url",
"id",
"url",
"username"
]
},
"UserRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"username": {
"type": "string",
"minLength": 1,
"description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
"pattern": "^[\\w.@+-]+$",
"maxLength": 150
},
"password": {
"type": "string",
"writeOnly": true,
"minLength": 1,
"maxLength": 128
},
"first_name": {
"type": "string",
"maxLength": 150
},
"last_name": {
"type": "string",
"maxLength": 150
},
"email": {
"type": "string",
"format": "email",
"title": "Email address",
"maxLength": 254
},
"is_staff": {
"type": "boolean",
"title": "Staff status",
"description": "Designates whether the user can log into this admin site."
},
"is_active": {
"type": "boolean",
"title": "Active",
"description": "Designates whether this user should be treated as active. Unselect this instead of deleting accounts."
},
"date_joined": {
"type": "string",
"format": "date-time"
},
"last_login": {
"type": "string",
"format": "date-time",
"nullable": true
},
"groups": {
"type": "array",
"items": {
"type": "integer"
}
},
"permissions": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"required": [
"password",
"username"
]
},
"VLAN": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"site": {
"allOf": [
{
"$ref": "#/components/schemas/BriefSite"
}
],
"nullable": true
},
"group": {
"allOf": [
{
"$ref": "#/components/schemas/BriefVLANGroup"
}
],
"nullable": true
},
"vid": {
"type": "integer",
"maximum": 4094,
"minimum": 1,
"title": "VLAN ID",
"description": "Numeric VLAN ID (1-4094)"
},
"name": {
"type": "string",
"maxLength": 64
},
"tenant": {
"allOf": [
{
"$ref": "#/components/schemas/BriefTenant"
}
],
"nullable": true
},
"status": {
"type": "object",
"properties": {
"value": {
"enum": [
"active",
"reserved",
"deprecated"
],
"type": "string",
"description": "* `active` - Active\n* `reserved` - Reserved\n* `deprecated` - Deprecated",
"x-spec-enum-id": "6388dfb94ca1cc15"
},
"label": {
"type": "string",
"enum": [
"Active",
"Reserved",
"Deprecated"
]
}
}
},
"role": {
"allOf": [
{
"$ref": "#/components/schemas/BriefRole"
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"qinq_role": {
"type": "object",
"properties": {
"value": {
"enum": [
"svlan",
"cvlan",
null
],
"type": "string",
"description": "* `svlan` - Service\n* `cvlan` - Customer",
"x-spec-enum-id": "d2510f2d3e3d3fb1"
},
"label": {
"type": "string",
"enum": [
"Service",
"Customer"
]
}
},
"nullable": true
},
"qinq_svlan": {
"allOf": [
{
"$ref": "#/components/schemas/NestedVLAN"
}
],
"nullable": true
},
"comments": {
"type": "string"
},
"l2vpn_termination": {
"allOf": [
{
"$ref": "#/components/schemas/BriefL2VPNTermination"
}
],
"readOnly": true,
"nullable": true
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"prefix_count": {
"type": "integer",
"format": "int64",
"readOnly": true
}
},
"required": [
"created",
"display",
"display_url",
"id",
"l2vpn_termination",
"last_updated",
"name",
"prefix_count",
"url",
"vid"
]
},
"VLANGroup": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"scope_type": {
"type": "string",
"nullable": true
},
"scope_id": {
"type": "integer",
"nullable": true
},
"scope": {
"nullable": true,
"readOnly": true
},
"vid_ranges": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IntegerRange"
}
},
"tenant": {
"allOf": [
{
"$ref": "#/components/schemas/BriefTenant"
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"vlan_count": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"utilization": {
"type": "string",
"readOnly": true
}
},
"required": [
"created",
"display",
"display_url",
"id",
"last_updated",
"name",
"scope",
"slug",
"url",
"utilization",
"vlan_count"
]
},
"VLANGroupRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"scope_type": {
"type": "string",
"nullable": true
},
"scope_id": {
"type": "integer",
"nullable": true
},
"vid_ranges": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IntegerRangeRequest"
}
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name",
"slug"
]
},
"VLANRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"site": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefSiteRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"group": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefVLANGroupRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"vid": {
"type": "integer",
"maximum": 4094,
"minimum": 1,
"title": "VLAN ID",
"description": "Numeric VLAN ID (1-4094)"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"status": {
"enum": [
"active",
"reserved",
"deprecated"
],
"type": "string",
"description": "* `active` - Active\n* `reserved` - Reserved\n* `deprecated` - Deprecated",
"x-spec-enum-id": "6388dfb94ca1cc15"
},
"role": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefRoleRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"qinq_role": {
"enum": [
"svlan",
"cvlan",
null
],
"type": "string",
"description": "* `svlan` - Service\n* `cvlan` - Customer",
"x-spec-enum-id": "d2510f2d3e3d3fb1",
"nullable": true
},
"qinq_svlan": {
"allOf": [
{
"$ref": "#/components/schemas/NestedVLANRequest"
}
],
"nullable": true
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name",
"vid"
]
},
"VLANTranslationPolicy": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"rules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VLANTranslationRule"
},
"readOnly": true
}
},
"required": [
"display",
"id",
"name",
"rules",
"url"
]
},
"VLANTranslationPolicyRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name"
]
},
"VLANTranslationRule": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"policy": {
"type": "integer"
},
"local_vid": {
"type": "integer",
"maximum": 4094,
"minimum": 1,
"title": "Local VLAN ID",
"description": "Numeric VLAN ID (1-4094)"
},
"remote_vid": {
"type": "integer",
"maximum": 4094,
"minimum": 1,
"title": "Remote VLAN ID",
"description": "Numeric VLAN ID (1-4094)"
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"display",
"id",
"local_vid",
"policy",
"remote_vid",
"url"
]
},
"VLANTranslationRuleRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"policy": {
"type": "integer"
},
"local_vid": {
"type": "integer",
"maximum": 4094,
"minimum": 1,
"title": "Local VLAN ID",
"description": "Numeric VLAN ID (1-4094)"
},
"remote_vid": {
"type": "integer",
"maximum": 4094,
"minimum": 1,
"title": "Remote VLAN ID",
"description": "Numeric VLAN ID (1-4094)"
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"local_vid",
"policy",
"remote_vid"
]
},
"VMInterface": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"virtual_machine": {
"$ref": "#/components/schemas/BriefVirtualMachine"
},
"name": {
"type": "string",
"maxLength": 64
},
"enabled": {
"type": "boolean"
},
"parent": {
"allOf": [
{
"$ref": "#/components/schemas/NestedVMInterface"
}
],
"nullable": true
},
"bridge": {
"allOf": [
{
"$ref": "#/components/schemas/NestedVMInterface"
}
],
"nullable": true
},
"mtu": {
"type": "integer",
"maximum": 65536,
"minimum": 1,
"nullable": true
},
"mac_address": {
"type": "string",
"readOnly": true,
"nullable": true
},
"primary_mac_address": {
"allOf": [
{
"$ref": "#/components/schemas/BriefMACAddress"
}
],
"nullable": true
},
"mac_addresses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BriefMACAddress"
},
"readOnly": true,
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"mode": {
"type": "object",
"properties": {
"value": {
"enum": [
"access",
"tagged",
"tagged-all",
"q-in-q",
""
],
"type": "string",
"description": "* `access` - Access\n* `tagged` - Tagged\n* `tagged-all` - Tagged (All)\n* `q-in-q` - Q-in-Q (802.1ad)",
"x-spec-enum-id": "b6fe48fe21dbf01d"
},
"label": {
"type": "string",
"enum": [
"Access",
"Tagged",
"Tagged (All)",
"Q-in-Q (802.1ad)"
]
}
}
},
"untagged_vlan": {
"allOf": [
{
"$ref": "#/components/schemas/BriefVLAN"
}
],
"nullable": true
},
"tagged_vlans": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VLAN"
}
},
"qinq_svlan": {
"allOf": [
{
"$ref": "#/components/schemas/BriefVLAN"
}
],
"nullable": true
},
"vlan_translation_policy": {
"allOf": [
{
"$ref": "#/components/schemas/BriefVLANTranslationPolicy"
}
],
"nullable": true
},
"vrf": {
"allOf": [
{
"$ref": "#/components/schemas/BriefVRF"
}
],
"nullable": true
},
"l2vpn_termination": {
"allOf": [
{
"$ref": "#/components/schemas/BriefL2VPNTermination"
}
],
"readOnly": true,
"nullable": true
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"count_ipaddresses": {
"type": "integer",
"readOnly": true
},
"count_fhrp_groups": {
"type": "integer",
"readOnly": true
}
},
"required": [
"count_fhrp_groups",
"count_ipaddresses",
"created",
"display",
"display_url",
"id",
"l2vpn_termination",
"last_updated",
"mac_address",
"mac_addresses",
"name",
"url",
"virtual_machine"
]
},
"VMInterfaceRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"virtual_machine": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefVirtualMachineRequest"
}
]
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"enabled": {
"type": "boolean"
},
"parent": {
"allOf": [
{
"$ref": "#/components/schemas/NestedVMInterfaceRequest"
}
],
"nullable": true
},
"bridge": {
"allOf": [
{
"$ref": "#/components/schemas/NestedVMInterfaceRequest"
}
],
"nullable": true
},
"mtu": {
"type": "integer",
"maximum": 65536,
"minimum": 1,
"nullable": true
},
"primary_mac_address": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefMACAddressRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"mode": {
"enum": [
"access",
"tagged",
"tagged-all",
"q-in-q",
""
],
"type": "string",
"description": "* `access` - Access\n* `tagged` - Tagged\n* `tagged-all` - Tagged (All)\n* `q-in-q` - Q-in-Q (802.1ad)",
"x-spec-enum-id": "b6fe48fe21dbf01d"
},
"untagged_vlan": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefVLANRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"tagged_vlans": {
"type": "array",
"items": {
"type": "integer"
}
},
"qinq_svlan": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefVLANRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"vlan_translation_policy": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefVLANTranslationPolicyRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"vrf": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefVRFRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name",
"virtual_machine"
]
},
"VRF": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"rd": {
"type": "string",
"nullable": true,
"title": "Route distinguisher",
"description": "Unique route distinguisher (as defined in RFC 4364)",
"maxLength": 21
},
"tenant": {
"allOf": [
{
"$ref": "#/components/schemas/BriefTenant"
}
],
"nullable": true
},
"enforce_unique": {
"type": "boolean",
"title": "Enforce unique space",
"description": "Prevent duplicate prefixes/IP addresses within this VRF"
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"import_targets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RouteTarget"
}
},
"export_targets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RouteTarget"
}
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"ipaddress_count": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"prefix_count": {
"type": "integer",
"format": "int64",
"readOnly": true
}
},
"required": [
"created",
"display",
"display_url",
"id",
"ipaddress_count",
"last_updated",
"name",
"prefix_count",
"url"
]
},
"VRFRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"rd": {
"type": "string",
"nullable": true,
"title": "Route distinguisher",
"description": "Unique route distinguisher (as defined in RFC 4364)",
"maxLength": 21
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"enforce_unique": {
"type": "boolean",
"title": "Enforce unique space",
"description": "Prevent duplicate prefixes/IP addresses within this VRF"
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"import_targets": {
"type": "array",
"items": {
"type": "integer"
}
},
"export_targets": {
"type": "array",
"items": {
"type": "integer"
}
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name"
]
},
"VirtualChassis": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 64
},
"domain": {
"type": "string",
"maxLength": 30
},
"master": {
"allOf": [
{
"$ref": "#/components/schemas/NestedDevice"
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"member_count": {
"type": "integer",
"readOnly": true
},
"members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedDevice"
},
"readOnly": true
}
},
"required": [
"created",
"display",
"display_url",
"id",
"last_updated",
"member_count",
"members",
"name",
"url"
]
},
"VirtualChassisRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"domain": {
"type": "string",
"maxLength": 30
},
"master": {
"allOf": [
{
"$ref": "#/components/schemas/NestedDeviceRequest"
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name"
]
},
"VirtualCircuit": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"cid": {
"type": "string",
"title": "Circuit ID",
"description": "Unique circuit ID",
"maxLength": 100
},
"provider_network": {
"$ref": "#/components/schemas/BriefProviderNetwork"
},
"provider_account": {
"allOf": [
{
"$ref": "#/components/schemas/BriefProviderAccount"
}
],
"nullable": true
},
"type": {
"$ref": "#/components/schemas/BriefVirtualCircuitType"
},
"status": {
"type": "object",
"properties": {
"value": {
"enum": [
"planned",
"provisioning",
"active",
"offline",
"deprovisioning",
"decommissioned"
],
"type": "string",
"description": "* `planned` - Planned\n* `provisioning` - Provisioning\n* `active` - Active\n* `offline` - Offline\n* `deprovisioning` - Deprovisioning\n* `decommissioned` - Decommissioned",
"x-spec-enum-id": "63c838134a022200"
},
"label": {
"type": "string",
"enum": [
"Planned",
"Provisioning",
"Active",
"Offline",
"Deprovisioning",
"Decommissioned"
]
}
}
},
"tenant": {
"allOf": [
{
"$ref": "#/components/schemas/BriefTenant"
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"cid",
"created",
"display",
"display_url",
"id",
"last_updated",
"provider_network",
"type",
"url"
]
},
"VirtualCircuitRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"cid": {
"type": "string",
"minLength": 1,
"title": "Circuit ID",
"description": "Unique circuit ID",
"maxLength": 100
},
"provider_network": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefProviderNetworkRequest"
}
]
},
"provider_account": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefProviderAccountRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"type": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefVirtualCircuitTypeRequest"
}
]
},
"status": {
"enum": [
"planned",
"provisioning",
"active",
"offline",
"deprovisioning",
"decommissioned"
],
"type": "string",
"description": "* `planned` - Planned\n* `provisioning` - Provisioning\n* `active` - Active\n* `offline` - Offline\n* `deprovisioning` - Deprovisioning\n* `decommissioned` - Decommissioned",
"x-spec-enum-id": "63c838134a022200"
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"cid",
"provider_network",
"type"
]
},
"VirtualCircuitTermination": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"virtual_circuit": {
"$ref": "#/components/schemas/BriefVirtualCircuit"
},
"role": {
"type": "object",
"properties": {
"value": {
"enum": [
"peer",
"hub",
"spoke"
],
"type": "string",
"description": "* `peer` - Peer\n* `hub` - Hub\n* `spoke` - Spoke",
"x-spec-enum-id": "52225cd60b867572"
},
"label": {
"type": "string",
"enum": [
"Peer",
"Hub",
"Spoke"
]
}
}
},
"interface": {
"$ref": "#/components/schemas/BriefInterface"
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"created",
"display",
"display_url",
"id",
"interface",
"last_updated",
"url",
"virtual_circuit"
]
},
"VirtualCircuitTerminationRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"virtual_circuit": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefVirtualCircuitRequest"
}
]
},
"role": {
"enum": [
"peer",
"hub",
"spoke"
],
"type": "string",
"description": "* `peer` - Peer\n* `hub` - Hub\n* `spoke` - Spoke",
"x-spec-enum-id": "52225cd60b867572"
},
"interface": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefInterfaceRequest"
}
]
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"interface",
"virtual_circuit"
]
},
"VirtualCircuitType": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"color": {
"type": "string",
"pattern": "^[0-9a-f]{6}$",
"maxLength": 6
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"virtual_circuit_count": {
"type": "integer",
"format": "int64",
"readOnly": true
}
},
"required": [
"created",
"display",
"display_url",
"id",
"last_updated",
"name",
"slug",
"url",
"virtual_circuit_count"
]
},
"VirtualCircuitTypeRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"color": {
"type": "string",
"pattern": "^[0-9a-f]{6}$",
"maxLength": 6
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name",
"slug"
]
},
"VirtualDeviceContext": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 64
},
"device": {
"$ref": "#/components/schemas/BriefDevice"
},
"identifier": {
"type": "integer",
"maximum": 32767,
"minimum": 0,
"nullable": true
},
"tenant": {
"allOf": [
{
"$ref": "#/components/schemas/BriefTenant"
}
],
"nullable": true
},
"primary_ip": {
"allOf": [
{
"$ref": "#/components/schemas/BriefIPAddress"
}
],
"readOnly": true,
"nullable": true
},
"primary_ip4": {
"allOf": [
{
"$ref": "#/components/schemas/BriefIPAddress"
}
],
"nullable": true
},
"primary_ip6": {
"allOf": [
{
"$ref": "#/components/schemas/BriefIPAddress"
}
],
"nullable": true
},
"status": {
"type": "object",
"properties": {
"value": {
"enum": [
"active",
"planned",
"offline"
],
"type": "string",
"description": "* `active` - Active\n* `planned` - Planned\n* `offline` - Offline",
"x-spec-enum-id": "ee1ef02def7a91ab"
},
"label": {
"type": "string",
"enum": [
"Active",
"Planned",
"Offline"
]
}
}
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"interface_count": {
"type": "integer",
"format": "int64",
"readOnly": true
}
},
"required": [
"created",
"device",
"display",
"display_url",
"id",
"interface_count",
"last_updated",
"name",
"primary_ip",
"status",
"url"
]
},
"VirtualDeviceContextRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"device": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDeviceRequest"
}
]
},
"identifier": {
"type": "integer",
"maximum": 32767,
"minimum": 0,
"nullable": true
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"primary_ip4": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefIPAddressRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"primary_ip6": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefIPAddressRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"status": {
"enum": [
"active",
"planned",
"offline"
],
"type": "string",
"description": "* `active` - Active\n* `planned` - Planned\n* `offline` - Offline",
"x-spec-enum-id": "ee1ef02def7a91ab"
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"device",
"name",
"status"
]
},
"VirtualDisk": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"virtual_machine": {
"$ref": "#/components/schemas/BriefVirtualMachine"
},
"name": {
"type": "string",
"maxLength": 64
},
"description": {
"type": "string",
"maxLength": 200
},
"size": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"title": "Size (MB)"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"created",
"display",
"display_url",
"id",
"last_updated",
"name",
"size",
"url",
"virtual_machine"
]
},
"VirtualDiskRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"virtual_machine": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefVirtualMachineRequest"
}
]
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"description": {
"type": "string",
"maxLength": 200
},
"size": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"title": "Size (MB)"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name",
"size",
"virtual_machine"
]
},
"VirtualMachineWithConfigContext": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 64
},
"status": {
"type": "object",
"properties": {
"value": {
"enum": [
"offline",
"active",
"planned",
"staged",
"failed",
"decommissioning",
"paused"
],
"type": "string",
"description": "* `offline` - Offline\n* `active` - Active\n* `planned` - Planned\n* `staged` - Staged\n* `failed` - Failed\n* `decommissioning` - Decommissioning\n* `paused` - Paused",
"x-spec-enum-id": "c649dc8de233760f"
},
"label": {
"type": "string",
"enum": [
"Offline",
"Active",
"Planned",
"Staged",
"Failed",
"Decommissioning",
"Paused"
]
}
}
},
"site": {
"allOf": [
{
"$ref": "#/components/schemas/BriefSite"
}
],
"nullable": true
},
"cluster": {
"allOf": [
{
"$ref": "#/components/schemas/BriefCluster"
}
],
"nullable": true
},
"device": {
"allOf": [
{
"$ref": "#/components/schemas/BriefDevice"
}
],
"nullable": true
},
"serial": {
"type": "string",
"title": "Serial number",
"maxLength": 50
},
"role": {
"allOf": [
{
"$ref": "#/components/schemas/BriefDeviceRole"
}
],
"nullable": true
},
"tenant": {
"allOf": [
{
"$ref": "#/components/schemas/BriefTenant"
}
],
"nullable": true
},
"platform": {
"allOf": [
{
"$ref": "#/components/schemas/BriefPlatform"
}
],
"nullable": true
},
"primary_ip": {
"allOf": [
{
"$ref": "#/components/schemas/BriefIPAddress"
}
],
"readOnly": true,
"nullable": true
},
"primary_ip4": {
"allOf": [
{
"$ref": "#/components/schemas/BriefIPAddress"
}
],
"nullable": true
},
"primary_ip6": {
"allOf": [
{
"$ref": "#/components/schemas/BriefIPAddress"
}
],
"nullable": true
},
"vcpus": {
"type": "number",
"format": "double",
"maximum": 10000,
"minimum": 0.01,
"exclusiveMaximum": true,
"nullable": true
},
"memory": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"title": "Memory (MB)"
},
"disk": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"title": "Disk (MB)"
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"config_template": {
"allOf": [
{
"$ref": "#/components/schemas/BriefConfigTemplate"
}
],
"nullable": true
},
"local_context_data": {
"nullable": true,
"description": "Local config context data takes precedence over source contexts in the final rendered config context"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"config_context": {
"nullable": true,
"readOnly": true
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"interface_count": {
"type": "integer",
"readOnly": true
},
"virtual_disk_count": {
"type": "integer",
"readOnly": true
}
},
"required": [
"config_context",
"created",
"display",
"display_url",
"id",
"interface_count",
"last_updated",
"name",
"primary_ip",
"url",
"virtual_disk_count"
]
},
"VirtualMachineWithConfigContextRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"status": {
"enum": [
"offline",
"active",
"planned",
"staged",
"failed",
"decommissioning",
"paused"
],
"type": "string",
"description": "* `offline` - Offline\n* `active` - Active\n* `planned` - Planned\n* `staged` - Staged\n* `failed` - Failed\n* `decommissioning` - Decommissioning\n* `paused` - Paused",
"x-spec-enum-id": "c649dc8de233760f"
},
"site": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefSiteRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"cluster": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefClusterRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"device": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefDeviceRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"serial": {
"type": "string",
"title": "Serial number",
"maxLength": 50
},
"role": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefDeviceRoleRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"platform": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefPlatformRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"primary_ip4": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefIPAddressRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"primary_ip6": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefIPAddressRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"vcpus": {
"type": "number",
"format": "double",
"maximum": 10000,
"minimum": 0.01,
"exclusiveMaximum": true,
"nullable": true
},
"memory": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"title": "Memory (MB)"
},
"disk": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"title": "Disk (MB)"
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"config_template": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefConfigTemplateRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"local_context_data": {
"nullable": true,
"description": "Local config context data takes precedence over source contexts in the final rendered config context"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name"
]
},
"Webhook": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 150
},
"description": {
"type": "string",
"maxLength": 200
},
"payload_url": {
"type": "string",
"title": "URL",
"description": "This URL will be called using the HTTP method defined when the webhook is called. Jinja2 template processing is supported with the same context as the request body.",
"maxLength": 500
},
"http_method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"type": "string",
"description": "* `GET` - GET\n* `POST` - POST\n* `PUT` - PUT\n* `PATCH` - PATCH\n* `DELETE` - DELETE",
"x-spec-enum-id": "a12018571a034921"
},
"http_content_type": {
"type": "string",
"description": "The complete list of official content types is available here.",
"maxLength": 100
},
"additional_headers": {
"type": "string",
"description": "User-supplied HTTP headers to be sent with the request in addition to the HTTP content type. Headers should be defined in the format Name: Value. Jinja2 template processing is supported with the same context as the request body (below)."
},
"body_template": {
"type": "string",
"description": "Jinja2 template for a custom request body. If blank, a JSON object representing the change will be included. Available context data includes: event, model, timestamp, username, request_id, and data."
},
"secret": {
"type": "string",
"description": "When provided, the request will include a X-Hook-Signature header containing a HMAC hex digest of the payload body using the secret as the key. The secret is not transmitted in the request.",
"maxLength": 255
},
"ssl_verification": {
"type": "boolean",
"description": "Enable SSL certificate verification. Disable with caution!"
},
"ca_file_path": {
"type": "string",
"nullable": true,
"description": "The specific CA certificate file to use for SSL verification. Leave blank to use the system defaults.",
"maxLength": 4096
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"created",
"display",
"display_url",
"id",
"last_updated",
"name",
"payload_url",
"url"
]
},
"WebhookRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 150
},
"description": {
"type": "string",
"maxLength": 200
},
"payload_url": {
"type": "string",
"minLength": 1,
"title": "URL",
"description": "This URL will be called using the HTTP method defined when the webhook is called. Jinja2 template processing is supported with the same context as the request body.",
"maxLength": 500
},
"http_method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"type": "string",
"description": "* `GET` - GET\n* `POST` - POST\n* `PUT` - PUT\n* `PATCH` - PATCH\n* `DELETE` - DELETE",
"x-spec-enum-id": "a12018571a034921"
},
"http_content_type": {
"type": "string",
"minLength": 1,
"description": "The complete list of official content types is available here.",
"maxLength": 100
},
"additional_headers": {
"type": "string",
"description": "User-supplied HTTP headers to be sent with the request in addition to the HTTP content type. Headers should be defined in the format Name: Value. Jinja2 template processing is supported with the same context as the request body (below)."
},
"body_template": {
"type": "string",
"description": "Jinja2 template for a custom request body. If blank, a JSON object representing the change will be included. Available context data includes: event, model, timestamp, username, request_id, and data."
},
"secret": {
"type": "string",
"description": "When provided, the request will include a X-Hook-Signature header containing a HMAC hex digest of the payload body using the secret as the key. The secret is not transmitted in the request.",
"maxLength": 255
},
"ssl_verification": {
"type": "boolean",
"description": "Enable SSL certificate verification. Disable with caution!"
},
"ca_file_path": {
"type": "string",
"nullable": true,
"description": "The specific CA certificate file to use for SSL verification. Leave blank to use the system defaults.",
"maxLength": 4096
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
}
},
"required": [
"name",
"payload_url"
]
},
"WirelessLAN": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"ssid": {
"type": "string",
"maxLength": 32
},
"description": {
"type": "string",
"maxLength": 200
},
"group": {
"allOf": [
{
"$ref": "#/components/schemas/BriefWirelessLANGroup"
}
],
"nullable": true
},
"status": {
"type": "object",
"properties": {
"value": {
"enum": [
"active",
"reserved",
"disabled",
"deprecated",
""
],
"type": "string",
"description": "* `active` - Active\n* `reserved` - Reserved\n* `disabled` - Disabled\n* `deprecated` - Deprecated",
"x-spec-enum-id": "412ebdca597f609e"
},
"label": {
"type": "string",
"enum": [
"Active",
"Reserved",
"Disabled",
"Deprecated"
]
}
}
},
"vlan": {
"allOf": [
{
"$ref": "#/components/schemas/BriefVLAN"
}
],
"nullable": true
},
"scope_type": {
"type": "string",
"nullable": true
},
"scope_id": {
"type": "integer",
"nullable": true
},
"scope": {
"nullable": true,
"readOnly": true
},
"tenant": {
"allOf": [
{
"$ref": "#/components/schemas/BriefTenant"
}
],
"nullable": true
},
"auth_type": {
"type": "object",
"properties": {
"value": {
"enum": [
"open",
"wep",
"wpa-personal",
"wpa-enterprise",
""
],
"type": "string",
"description": "* `open` - Open\n* `wep` - WEP\n* `wpa-personal` - WPA Personal (PSK)\n* `wpa-enterprise` - WPA Enterprise",
"x-spec-enum-id": "a2043acb899b3954"
},
"label": {
"type": "string",
"enum": [
"Open",
"WEP",
"WPA Personal (PSK)",
"WPA Enterprise"
]
}
}
},
"auth_cipher": {
"type": "object",
"properties": {
"value": {
"enum": [
"auto",
"tkip",
"aes",
""
],
"type": "string",
"description": "* `auto` - Auto\n* `tkip` - TKIP\n* `aes` - AES",
"x-spec-enum-id": "8fdaefa727c26fdc"
},
"label": {
"type": "string",
"enum": [
"Auto",
"TKIP",
"AES"
]
}
}
},
"auth_psk": {
"type": "string",
"title": "Pre-shared key",
"maxLength": 64
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"created",
"display",
"display_url",
"id",
"last_updated",
"scope",
"ssid",
"url"
]
},
"WirelessLANGroup": {
"type": "object",
"description": "Extends PrimaryModelSerializer to include MPTT support.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 100
},
"slug": {
"type": "string",
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"parent": {
"allOf": [
{
"$ref": "#/components/schemas/NestedWirelessLANGroup"
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"wirelesslan_count": {
"type": "integer",
"readOnly": true,
"default": 0
},
"comments": {
"type": "string"
},
"_depth": {
"type": "integer",
"readOnly": true,
"title": " depth"
}
},
"required": [
"_depth",
"created",
"display",
"display_url",
"id",
"last_updated",
"name",
"slug",
"url",
"wirelesslan_count"
]
},
"WirelessLANGroupRequest": {
"type": "object",
"description": "Extends PrimaryModelSerializer to include MPTT support.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"parent": {
"allOf": [
{
"$ref": "#/components/schemas/NestedWirelessLANGroupRequest"
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"comments": {
"type": "string"
}
},
"required": [
"name",
"slug"
]
},
"WirelessLANRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"ssid": {
"type": "string",
"minLength": 1,
"maxLength": 32
},
"description": {
"type": "string",
"maxLength": 200
},
"group": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefWirelessLANGroupRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"status": {
"enum": [
"active",
"reserved",
"disabled",
"deprecated",
""
],
"type": "string",
"description": "* `active` - Active\n* `reserved` - Reserved\n* `disabled` - Disabled\n* `deprecated` - Deprecated",
"x-spec-enum-id": "412ebdca597f609e"
},
"vlan": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefVLANRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"scope_type": {
"type": "string",
"nullable": true
},
"scope_id": {
"type": "integer",
"nullable": true
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"auth_type": {
"enum": [
"open",
"wep",
"wpa-personal",
"wpa-enterprise",
""
],
"type": "string",
"description": "* `open` - Open\n* `wep` - WEP\n* `wpa-personal` - WPA Personal (PSK)\n* `wpa-enterprise` - WPA Enterprise",
"x-spec-enum-id": "a2043acb899b3954"
},
"auth_cipher": {
"enum": [
"auto",
"tkip",
"aes",
""
],
"type": "string",
"description": "* `auto` - Auto\n* `tkip` - TKIP\n* `aes` - AES",
"x-spec-enum-id": "8fdaefa727c26fdc"
},
"auth_psk": {
"type": "string",
"title": "Pre-shared key",
"maxLength": 64
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"ssid"
]
},
"WirelessLink": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display_url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"display": {
"type": "string",
"readOnly": true
},
"interface_a": {
"$ref": "#/components/schemas/BriefInterface"
},
"interface_b": {
"$ref": "#/components/schemas/BriefInterface"
},
"ssid": {
"type": "string",
"maxLength": 32
},
"status": {
"type": "object",
"properties": {
"value": {
"enum": [
"connected",
"planned",
"decommissioning"
],
"type": "string",
"description": "* `connected` - Connected\n* `planned` - Planned\n* `decommissioning` - Decommissioning",
"x-spec-enum-id": "fbc2f302c08be50d"
},
"label": {
"type": "string",
"enum": [
"Connected",
"Planned",
"Decommissioning"
]
}
}
},
"tenant": {
"allOf": [
{
"$ref": "#/components/schemas/BriefTenant"
}
],
"nullable": true
},
"auth_type": {
"type": "object",
"properties": {
"value": {
"enum": [
"open",
"wep",
"wpa-personal",
"wpa-enterprise",
""
],
"type": "string",
"description": "* `open` - Open\n* `wep` - WEP\n* `wpa-personal` - WPA Personal (PSK)\n* `wpa-enterprise` - WPA Enterprise",
"x-spec-enum-id": "a2043acb899b3954"
},
"label": {
"type": "string",
"enum": [
"Open",
"WEP",
"WPA Personal (PSK)",
"WPA Enterprise"
]
}
}
},
"auth_cipher": {
"type": "object",
"properties": {
"value": {
"enum": [
"auto",
"tkip",
"aes",
""
],
"type": "string",
"description": "* `auto` - Auto\n* `tkip` - TKIP\n* `aes` - AES",
"x-spec-enum-id": "8fdaefa727c26fdc"
},
"label": {
"type": "string",
"enum": [
"Auto",
"TKIP",
"AES"
]
}
}
},
"auth_psk": {
"type": "string",
"title": "Pre-shared key",
"maxLength": 64
},
"distance": {
"type": "number",
"format": "double",
"maximum": 1000000,
"minimum": -1000000,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true
},
"distance_unit": {
"type": "object",
"properties": {
"value": {
"enum": [
"km",
"m",
"mi",
"ft",
"",
null
],
"type": "string",
"description": "* `km` - Kilometers\n* `m` - Meters\n* `mi` - Miles\n* `ft` - Feet",
"x-spec-enum-id": "53542e7902f946af"
},
"label": {
"type": "string",
"enum": [
"Kilometers",
"Meters",
"Miles",
"Feet"
]
}
},
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTag"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
},
"last_updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"nullable": true
}
},
"required": [
"created",
"display",
"display_url",
"id",
"interface_a",
"interface_b",
"last_updated",
"url"
]
},
"WirelessLinkRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"interface_a": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefInterfaceRequest"
}
]
},
"interface_b": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefInterfaceRequest"
}
]
},
"ssid": {
"type": "string",
"maxLength": 32
},
"status": {
"enum": [
"connected",
"planned",
"decommissioning"
],
"type": "string",
"description": "* `connected` - Connected\n* `planned` - Planned\n* `decommissioning` - Decommissioning",
"x-spec-enum-id": "fbc2f302c08be50d"
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"auth_type": {
"enum": [
"open",
"wep",
"wpa-personal",
"wpa-enterprise",
""
],
"type": "string",
"description": "* `open` - Open\n* `wep` - WEP\n* `wpa-personal` - WPA Personal (PSK)\n* `wpa-enterprise` - WPA Enterprise",
"x-spec-enum-id": "a2043acb899b3954"
},
"auth_cipher": {
"enum": [
"auto",
"tkip",
"aes",
""
],
"type": "string",
"description": "* `auto` - Auto\n* `tkip` - TKIP\n* `aes` - AES",
"x-spec-enum-id": "8fdaefa727c26fdc"
},
"auth_psk": {
"type": "string",
"title": "Pre-shared key",
"maxLength": 64
},
"distance": {
"type": "number",
"format": "double",
"maximum": 1000000,
"minimum": -1000000,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true
},
"distance_unit": {
"enum": [
"km",
"m",
"mi",
"ft",
"",
null
],
"type": "string",
"description": "* `km` - Kilometers\n* `m` - Meters\n* `mi` - Miles\n* `ft` - Feet",
"x-spec-enum-id": "53542e7902f946af",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"interface_a",
"interface_b"
]
},
"WritableAggregateRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"prefix": {
"type": "string",
"minLength": 1
},
"rir": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefRIRRequest"
}
]
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"date_added": {
"type": "string",
"format": "date",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"prefix",
"rir"
]
},
"WritableCableRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"type": {
"enum": [
"cat3",
"cat5",
"cat5e",
"cat6",
"cat6a",
"cat7",
"cat7a",
"cat8",
"dac-active",
"dac-passive",
"mrj21-trunk",
"coaxial",
"mmf",
"mmf-om1",
"mmf-om2",
"mmf-om3",
"mmf-om4",
"mmf-om5",
"smf",
"smf-os1",
"smf-os2",
"aoc",
"usb",
"power",
"",
null
],
"type": "string",
"description": "* `cat3` - CAT3\n* `cat5` - CAT5\n* `cat5e` - CAT5e\n* `cat6` - CAT6\n* `cat6a` - CAT6a\n* `cat7` - CAT7\n* `cat7a` - CAT7a\n* `cat8` - CAT8\n* `dac-active` - Direct Attach Copper (Active)\n* `dac-passive` - Direct Attach Copper (Passive)\n* `mrj21-trunk` - MRJ21 Trunk\n* `coaxial` - Coaxial\n* `mmf` - Multimode Fiber\n* `mmf-om1` - Multimode Fiber (OM1)\n* `mmf-om2` - Multimode Fiber (OM2)\n* `mmf-om3` - Multimode Fiber (OM3)\n* `mmf-om4` - Multimode Fiber (OM4)\n* `mmf-om5` - Multimode Fiber (OM5)\n* `smf` - Singlemode Fiber\n* `smf-os1` - Singlemode Fiber (OS1)\n* `smf-os2` - Singlemode Fiber (OS2)\n* `aoc` - Active Optical Cabling (AOC)\n* `usb` - USB\n* `power` - Power",
"x-spec-enum-id": "7b11d524b2b1a7ef",
"nullable": true
},
"a_terminations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GenericObjectRequest"
}
},
"b_terminations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GenericObjectRequest"
}
},
"status": {
"enum": [
"connected",
"planned",
"decommissioning"
],
"type": "string",
"description": "* `connected` - Connected\n* `planned` - Planned\n* `decommissioning` - Decommissioning",
"x-spec-enum-id": "fbc2f302c08be50d"
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"label": {
"type": "string",
"maxLength": 100
},
"color": {
"type": "string",
"pattern": "^[0-9a-f]{6}$",
"maxLength": 6
},
"length": {
"type": "number",
"format": "double",
"maximum": 1000000,
"minimum": -1000000,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true
},
"length_unit": {
"enum": [
"km",
"m",
"cm",
"mi",
"ft",
"in",
"",
null
],
"type": "string",
"description": "* `km` - Kilometers\n* `m` - Meters\n* `cm` - Centimeters\n* `mi` - Miles\n* `ft` - Feet\n* `in` - Inches",
"x-spec-enum-id": "e64ce3a2c5997172",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
}
},
"WritableCircuitGroupAssignmentRequest": {
"type": "object",
"description": "Base serializer for group assignments under CircuitSerializer.",
"properties": {
"group": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefCircuitGroupRequest"
}
]
},
"member_type": {
"type": "string"
},
"member_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64"
},
"priority": {
"enum": [
"primary",
"secondary",
"tertiary",
"inactive",
"",
null
],
"type": "string",
"description": "* `primary` - Primary\n* `secondary` - Secondary\n* `tertiary` - Tertiary\n* `inactive` - Inactive",
"x-spec-enum-id": "ef3a31644cec7524",
"nullable": true
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
}
},
"required": [
"group",
"member_id",
"member_type"
]
},
"WritableCircuitRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"cid": {
"type": "string",
"minLength": 1,
"title": "Circuit ID",
"description": "Unique circuit ID",
"maxLength": 100
},
"provider": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefProviderRequest"
}
]
},
"provider_account": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefProviderAccountRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"type": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefCircuitTypeRequest"
}
]
},
"status": {
"enum": [
"planned",
"provisioning",
"active",
"offline",
"deprovisioning",
"decommissioned"
],
"type": "string",
"description": "* `planned` - Planned\n* `provisioning` - Provisioning\n* `active` - Active\n* `offline` - Offline\n* `deprovisioning` - Deprovisioning\n* `decommissioned` - Decommissioned",
"x-spec-enum-id": "63c838134a022200"
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"install_date": {
"type": "string",
"format": "date",
"nullable": true,
"title": "Installed"
},
"termination_date": {
"type": "string",
"format": "date",
"nullable": true,
"title": "Terminates"
},
"commit_rate": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"title": "Commit rate (Kbps)",
"description": "Committed rate"
},
"description": {
"type": "string",
"maxLength": 200
},
"distance": {
"type": "number",
"format": "double",
"maximum": 1000000,
"minimum": -1000000,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true
},
"distance_unit": {
"enum": [
"km",
"m",
"mi",
"ft",
"",
null
],
"type": "string",
"description": "* `km` - Kilometers\n* `m` - Meters\n* `mi` - Miles\n* `ft` - Feet",
"x-spec-enum-id": "53542e7902f946af",
"nullable": true
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"assignments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BriefCircuitGroupAssignmentSerializer_Request"
}
}
},
"required": [
"cid",
"provider",
"type"
]
},
"WritableClusterRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"type": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefClusterTypeRequest"
}
]
},
"group": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefClusterGroupRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"status": {
"enum": [
"planned",
"staging",
"active",
"decommissioning",
"offline"
],
"type": "string",
"description": "* `planned` - Planned\n* `staging` - Staging\n* `active` - Active\n* `decommissioning` - Decommissioning\n* `offline` - Offline",
"x-spec-enum-id": "79d20a734d0eecbb"
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"scope_type": {
"type": "string",
"nullable": true
},
"scope_id": {
"type": "integer",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name",
"type"
]
},
"WritableConsolePortRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"device": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDeviceRequest"
}
]
},
"module": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"enum": [
"de-9",
"db-25",
"rj-11",
"rj-12",
"rj-45",
"mini-din-8",
"usb-a",
"usb-b",
"usb-c",
"usb-mini-a",
"usb-mini-b",
"usb-micro-a",
"usb-micro-b",
"usb-micro-ab",
"other",
"",
null
],
"type": "string",
"x-spec-enum-id": "c5f7197b7211818a",
"nullable": true,
"description": "Physical port type\n\n* `de-9` - DE-9\n* `db-25` - DB-25\n* `rj-11` - RJ-11\n* `rj-12` - RJ-12\n* `rj-45` - RJ-45\n* `mini-din-8` - Mini-DIN 8\n* `usb-a` - USB Type A\n* `usb-b` - USB Type B\n* `usb-c` - USB Type C\n* `usb-mini-a` - USB Mini A\n* `usb-mini-b` - USB Mini B\n* `usb-micro-a` - USB Micro A\n* `usb-micro-b` - USB Micro B\n* `usb-micro-ab` - USB Micro AB\n* `other` - Other"
},
"speed": {
"enum": [
1200,
2400,
4800,
9600,
19200,
38400,
57600,
115200,
null
],
"type": "integer",
"x-spec-enum-id": "ab6d9635c131a378",
"nullable": true,
"description": "Port speed in bits per second\n\n* `1200` - 1200 bps\n* `2400` - 2400 bps\n* `4800` - 4800 bps\n* `9600` - 9600 bps\n* `19200` - 19.2 kbps\n* `38400` - 38.4 kbps\n* `57600` - 57.6 kbps\n* `115200` - 115.2 kbps",
"minimum": 0,
"maximum": 2147483647
},
"description": {
"type": "string",
"maxLength": 200
},
"mark_connected": {
"type": "boolean",
"description": "Treat as if a cable is connected"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"device",
"name"
]
},
"WritableConsolePortTemplateRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"device_type": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefDeviceTypeRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"module_type": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleTypeRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"description": "{module} is accepted as a substitution for the module bay position when attached to a module type.",
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"enum": [
"de-9",
"db-25",
"rj-11",
"rj-12",
"rj-45",
"mini-din-8",
"usb-a",
"usb-b",
"usb-c",
"usb-mini-a",
"usb-mini-b",
"usb-micro-a",
"usb-micro-b",
"usb-micro-ab",
"other",
"",
null
],
"type": "string",
"description": "* `de-9` - DE-9\n* `db-25` - DB-25\n* `rj-11` - RJ-11\n* `rj-12` - RJ-12\n* `rj-45` - RJ-45\n* `mini-din-8` - Mini-DIN 8\n* `usb-a` - USB Type A\n* `usb-b` - USB Type B\n* `usb-c` - USB Type C\n* `usb-mini-a` - USB Mini A\n* `usb-mini-b` - USB Mini B\n* `usb-micro-a` - USB Micro A\n* `usb-micro-b` - USB Micro B\n* `usb-micro-ab` - USB Micro AB\n* `other` - Other",
"x-spec-enum-id": "c5f7197b7211818a",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name"
]
},
"WritableConsoleServerPortRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"device": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDeviceRequest"
}
]
},
"module": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"enum": [
"de-9",
"db-25",
"rj-11",
"rj-12",
"rj-45",
"mini-din-8",
"usb-a",
"usb-b",
"usb-c",
"usb-mini-a",
"usb-mini-b",
"usb-micro-a",
"usb-micro-b",
"usb-micro-ab",
"other",
"",
null
],
"type": "string",
"x-spec-enum-id": "c5f7197b7211818a",
"nullable": true,
"description": "Physical port type\n\n* `de-9` - DE-9\n* `db-25` - DB-25\n* `rj-11` - RJ-11\n* `rj-12` - RJ-12\n* `rj-45` - RJ-45\n* `mini-din-8` - Mini-DIN 8\n* `usb-a` - USB Type A\n* `usb-b` - USB Type B\n* `usb-c` - USB Type C\n* `usb-mini-a` - USB Mini A\n* `usb-mini-b` - USB Mini B\n* `usb-micro-a` - USB Micro A\n* `usb-micro-b` - USB Micro B\n* `usb-micro-ab` - USB Micro AB\n* `other` - Other"
},
"speed": {
"enum": [
1200,
2400,
4800,
9600,
19200,
38400,
57600,
115200,
null
],
"type": "integer",
"x-spec-enum-id": "ab6d9635c131a378",
"nullable": true,
"description": "Port speed in bits per second\n\n* `1200` - 1200 bps\n* `2400` - 2400 bps\n* `4800` - 4800 bps\n* `9600` - 9600 bps\n* `19200` - 19.2 kbps\n* `38400` - 38.4 kbps\n* `57600` - 57.6 kbps\n* `115200` - 115.2 kbps",
"minimum": 0,
"maximum": 2147483647
},
"description": {
"type": "string",
"maxLength": 200
},
"mark_connected": {
"type": "boolean",
"description": "Treat as if a cable is connected"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"device",
"name"
]
},
"WritableConsoleServerPortTemplateRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"device_type": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefDeviceTypeRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"module_type": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleTypeRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"description": "{module} is accepted as a substitution for the module bay position when attached to a module type.",
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"enum": [
"de-9",
"db-25",
"rj-11",
"rj-12",
"rj-45",
"mini-din-8",
"usb-a",
"usb-b",
"usb-c",
"usb-mini-a",
"usb-mini-b",
"usb-micro-a",
"usb-micro-b",
"usb-micro-ab",
"other",
"",
null
],
"type": "string",
"description": "* `de-9` - DE-9\n* `db-25` - DB-25\n* `rj-11` - RJ-11\n* `rj-12` - RJ-12\n* `rj-45` - RJ-45\n* `mini-din-8` - Mini-DIN 8\n* `usb-a` - USB Type A\n* `usb-b` - USB Type B\n* `usb-c` - USB Type C\n* `usb-mini-a` - USB Mini A\n* `usb-mini-b` - USB Mini B\n* `usb-micro-a` - USB Micro A\n* `usb-micro-b` - USB Micro B\n* `usb-micro-ab` - USB Micro AB\n* `other` - Other",
"x-spec-enum-id": "c5f7197b7211818a",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name"
]
},
"WritableContactAssignmentRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"object_type": {
"type": "string"
},
"object_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64"
},
"contact": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefContactRequest"
}
]
},
"role": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefContactRoleRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"priority": {
"enum": [
"primary",
"secondary",
"tertiary",
"inactive",
"",
null
],
"type": "string",
"description": "* `primary` - Primary\n* `secondary` - Secondary\n* `tertiary` - Tertiary\n* `inactive` - Inactive",
"x-spec-enum-id": "ef3a31644cec7524",
"nullable": true
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"contact",
"object_id",
"object_type"
]
},
"WritableContactGroupRequest": {
"type": "object",
"description": "Extends PrimaryModelSerializer to include MPTT support.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"parent": {
"type": "integer",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"comments": {
"type": "string"
}
},
"required": [
"name",
"slug"
]
},
"WritableCustomFieldChoiceSetRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"base_choices": {
"enum": [
"IATA",
"ISO_3166",
"UN_LOCODE",
"",
null
],
"type": "string",
"x-spec-enum-id": "cf0efb5195f85007",
"nullable": true,
"description": "Base set of predefined choices (optional)\n\n* `IATA` - IATA (Airport codes)\n* `ISO_3166` - ISO 3166 (Country codes)\n* `UN_LOCODE` - UN/LOCODE (Location codes)"
},
"extra_choices": {
"type": "array",
"items": {
"type": "array",
"items": {},
"maxItems": 2,
"minItems": 2
}
},
"order_alphabetically": {
"type": "boolean",
"description": "Choices are automatically ordered alphabetically"
}
},
"required": [
"extra_choices",
"name"
]
},
"WritableCustomFieldRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"object_types": {
"type": "array",
"items": {
"type": "string"
}
},
"type": {
"enum": [
"text",
"longtext",
"integer",
"decimal",
"boolean",
"date",
"datetime",
"url",
"json",
"select",
"multiselect",
"object",
"multiobject"
],
"type": "string",
"x-spec-enum-id": "22e3a64138d10046",
"description": "The type of data this custom field holds\n\n* `text` - Text\n* `longtext` - Text (long)\n* `integer` - Integer\n* `decimal` - Decimal\n* `boolean` - Boolean (true/false)\n* `date` - Date\n* `datetime` - Date & time\n* `url` - URL\n* `json` - JSON\n* `select` - Selection\n* `multiselect` - Multiple selection\n* `object` - Object\n* `multiobject` - Multiple objects"
},
"related_object_type": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"description": "Internal field name",
"pattern": "^[a-z0-9_]+$",
"maxLength": 50
},
"label": {
"type": "string",
"description": "Name of the field as displayed to users (if not provided, 'the field's name will be used)",
"maxLength": 50
},
"group_name": {
"type": "string",
"description": "Custom fields within the same group will be displayed together",
"maxLength": 50
},
"description": {
"type": "string",
"maxLength": 200
},
"required": {
"type": "boolean",
"description": "This field is required when creating new objects or editing an existing object."
},
"unique": {
"type": "boolean",
"title": "Must be unique",
"description": "The value of this field must be unique for the assigned object"
},
"search_weight": {
"type": "integer",
"maximum": 32767,
"minimum": 0,
"description": "Weighting for search. Lower values are considered more important. Fields with a search weight of zero will be ignored."
},
"filter_logic": {
"enum": [
"disabled",
"loose",
"exact"
],
"type": "string",
"x-spec-enum-id": "a958350ae21c10ee",
"description": "Loose matches any instance of a given string; exact matches the entire field.\n\n* `disabled` - Disabled\n* `loose` - Loose\n* `exact` - Exact"
},
"ui_visible": {
"enum": [
"always",
"if-set",
"hidden"
],
"type": "string",
"x-spec-enum-id": "cd2cf94af56de747",
"description": "Specifies whether the custom field is displayed in the UI\n\n* `always` - Always\n* `if-set` - If set\n* `hidden` - Hidden"
},
"ui_editable": {
"enum": [
"yes",
"no",
"hidden"
],
"type": "string",
"x-spec-enum-id": "1065673147e26bb5",
"description": "Specifies whether the custom field value can be edited in the UI\n\n* `yes` - Yes\n* `no` - No\n* `hidden` - Hidden"
},
"is_cloneable": {
"type": "boolean",
"description": "Replicate this value when cloning objects"
},
"default": {
"nullable": true,
"description": "Default value for the field (must be a JSON value). Encapsulate strings with double quotes (e.g. \"Foo\")."
},
"related_object_filter": {
"nullable": true,
"description": "Filter the object selection choices using a query_params dict (must be a JSON value).Encapsulate strings with double quotes (e.g. \"Foo\")."
},
"weight": {
"type": "integer",
"maximum": 32767,
"minimum": 0,
"title": "Display weight",
"description": "Fields with higher weights appear lower in a form."
},
"validation_minimum": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"format": "int64",
"nullable": true,
"title": "Minimum value",
"description": "Minimum allowed value (for numeric fields)"
},
"validation_maximum": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"format": "int64",
"nullable": true,
"title": "Maximum value",
"description": "Maximum allowed value (for numeric fields)"
},
"validation_regex": {
"type": "string",
"description": "Regular expression to enforce on text field values. Use ^ and $ to force matching of entire string. For example, ^[A-Z]{3}$ will limit values to exactly three uppercase letters.",
"maxLength": 500
},
"choice_set": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefCustomFieldChoiceSetRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"comments": {
"type": "string"
}
},
"required": [
"name",
"object_types"
]
},
"WritableDataSourceRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"type": {
"type": "string",
"minLength": 1,
"maxLength": 50
},
"source_url": {
"type": "string",
"minLength": 1,
"title": "URL",
"maxLength": 200
},
"enabled": {
"type": "boolean"
},
"description": {
"type": "string",
"maxLength": 200
},
"sync_interval": {
"enum": [
1,
60,
720,
1440,
10080,
43200,
null
],
"type": "integer",
"description": "* `1` - Minutely\n* `60` - Hourly\n* `720` - 12 hours\n* `1440` - Daily\n* `10080` - Weekly\n* `43200` - 30 days",
"x-spec-enum-id": "2e9f2567ecd93fbe",
"nullable": true,
"minimum": 0,
"maximum": 32767
},
"parameters": {
"nullable": true
},
"ignore_rules": {
"type": "string",
"description": "Patterns (one per line) matching files to ignore when syncing"
},
"comments": {
"type": "string"
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name",
"source_url",
"type"
]
},
"WritableDeviceRoleRequest": {
"type": "object",
"description": "Extends PrimaryModelSerializer to include MPTT support.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"color": {
"type": "string",
"minLength": 1,
"pattern": "^[0-9a-f]{6}$",
"maxLength": 6
},
"vm_role": {
"type": "boolean",
"description": "Virtual machines may be assigned to this role"
},
"config_template": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefConfigTemplateRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"parent": {
"type": "integer",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"comments": {
"type": "string"
}
},
"required": [
"name",
"slug"
]
},
"WritableDeviceTypeRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"manufacturer": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefManufacturerRequest"
}
]
},
"default_platform": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefPlatformRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"model": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"part_number": {
"type": "string",
"description": "Discrete part number (optional)",
"maxLength": 50
},
"u_height": {
"type": "number",
"format": "double",
"maximum": 1000,
"minimum": 0.0,
"exclusiveMaximum": true,
"default": 1.0,
"title": "Position (U)"
},
"exclude_from_utilization": {
"type": "boolean",
"description": "Devices of this type are excluded when calculating rack utilization."
},
"is_full_depth": {
"type": "boolean",
"description": "Device consumes both front and rear rack faces."
},
"subdevice_role": {
"enum": [
"parent",
"child",
"",
null
],
"type": "string",
"x-spec-enum-id": "d10d91f690a856c2",
"nullable": true,
"title": "Parent/child status",
"description": "Parent devices house child devices in device bays. Leave blank if this device type is neither a parent nor a child.\n\n* `parent` - Parent\n* `child` - Child"
},
"airflow": {
"enum": [
"front-to-rear",
"rear-to-front",
"left-to-right",
"right-to-left",
"side-to-rear",
"rear-to-side",
"bottom-to-top",
"top-to-bottom",
"passive",
"mixed",
"",
null
],
"type": "string",
"description": "* `front-to-rear` - Front to rear\n* `rear-to-front` - Rear to front\n* `left-to-right` - Left to right\n* `right-to-left` - Right to left\n* `side-to-rear` - Side to rear\n* `rear-to-side` - Rear to side\n* `bottom-to-top` - Bottom to top\n* `top-to-bottom` - Top to bottom\n* `passive` - Passive\n* `mixed` - Mixed",
"x-spec-enum-id": "943288113dad6782",
"nullable": true
},
"weight": {
"type": "number",
"format": "double",
"maximum": 1000000,
"minimum": -1000000,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true
},
"weight_unit": {
"enum": [
"kg",
"g",
"lb",
"oz",
"",
null
],
"type": "string",
"description": "* `kg` - Kilograms\n* `g` - Grams\n* `lb` - Pounds\n* `oz` - Ounces",
"x-spec-enum-id": "7c1876f422815884",
"nullable": true
},
"front_image": {
"type": "string",
"format": "binary",
"nullable": true
},
"rear_image": {
"type": "string",
"format": "binary",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"manufacturer",
"model",
"slug"
]
},
"WritableDeviceWithConfigContextRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"nullable": true,
"maxLength": 64
},
"device_type": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDeviceTypeRequest"
}
]
},
"role": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDeviceRoleRequest"
}
]
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"platform": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefPlatformRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"serial": {
"type": "string",
"title": "Serial number",
"description": "Chassis serial number, assigned by the manufacturer",
"maxLength": 50
},
"asset_tag": {
"type": "string",
"nullable": true,
"description": "A unique tag used to identify this device",
"maxLength": 50
},
"site": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefSiteRequest"
}
]
},
"location": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefLocationRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"rack": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefRackRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"position": {
"type": "number",
"format": "double",
"maximum": 1000,
"minimum": 0.5,
"exclusiveMaximum": true,
"nullable": true,
"title": "Position (U)"
},
"face": {
"enum": [
"front",
"rear",
"",
null
],
"type": "string",
"description": "* `front` - Front\n* `rear` - Rear",
"x-spec-enum-id": "d2fb9b3f75158b83",
"nullable": true,
"title": "Rack face"
},
"latitude": {
"type": "number",
"format": "double",
"maximum": 100,
"minimum": -100,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true,
"description": "GPS coordinate in decimal format (xx.yyyyyy)"
},
"longitude": {
"type": "number",
"format": "double",
"maximum": 1000,
"minimum": -1000,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true,
"description": "GPS coordinate in decimal format (xx.yyyyyy)"
},
"status": {
"enum": [
"offline",
"active",
"planned",
"staged",
"failed",
"inventory",
"decommissioning"
],
"type": "string",
"description": "* `offline` - Offline\n* `active` - Active\n* `planned` - Planned\n* `staged` - Staged\n* `failed` - Failed\n* `inventory` - Inventory\n* `decommissioning` - Decommissioning",
"x-spec-enum-id": "8d8971779f16ee18"
},
"airflow": {
"enum": [
"front-to-rear",
"rear-to-front",
"left-to-right",
"right-to-left",
"side-to-rear",
"rear-to-side",
"bottom-to-top",
"top-to-bottom",
"passive",
"mixed",
"",
null
],
"type": "string",
"description": "* `front-to-rear` - Front to rear\n* `rear-to-front` - Rear to front\n* `left-to-right` - Left to right\n* `right-to-left` - Right to left\n* `side-to-rear` - Side to rear\n* `rear-to-side` - Rear to side\n* `bottom-to-top` - Bottom to top\n* `top-to-bottom` - Top to bottom\n* `passive` - Passive\n* `mixed` - Mixed",
"x-spec-enum-id": "943288113dad6782",
"nullable": true
},
"primary_ip4": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefIPAddressRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"primary_ip6": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefIPAddressRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"oob_ip": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefIPAddressRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"cluster": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefClusterRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"virtual_chassis": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefVirtualChassisRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"vc_position": {
"type": "integer",
"maximum": 255,
"minimum": 0,
"nullable": true
},
"vc_priority": {
"type": "integer",
"maximum": 255,
"minimum": 0,
"nullable": true,
"description": "Virtual chassis master election priority"
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"config_template": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefConfigTemplateRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"local_context_data": {
"nullable": true,
"description": "Local config context data takes precedence over source contexts in the final rendered config context"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"device_type",
"role",
"site"
]
},
"WritableEventRuleRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"object_types": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 150
},
"enabled": {
"type": "boolean"
},
"event_types": {
"type": "array",
"items": {
"enum": [
"object_created",
"object_updated",
"object_deleted",
"job_started",
"job_completed",
"job_failed",
"job_errored"
],
"type": "string",
"description": "* `object_created` - Object created\n* `object_updated` - Object updated\n* `object_deleted` - Object deleted\n* `job_started` - Job started\n* `job_completed` - Job completed\n* `job_failed` - Job failed\n* `job_errored` - Job errored",
"x-spec-enum-id": "80d172232f4af424"
},
"description": "The types of event which will trigger this rule."
},
"conditions": {
"nullable": true,
"description": "A set of conditions which determine whether the event will be generated."
},
"action_type": {
"enum": [
"webhook",
"script",
"notification"
],
"type": "string",
"description": "* `webhook` - Webhook\n* `script` - Script\n* `notification` - Notification",
"x-spec-enum-id": "d07193c73ebc03c6"
},
"action_object_type": {
"type": "string"
},
"action_object_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
}
},
"required": [
"action_object_type",
"event_types",
"name",
"object_types"
]
},
"WritableFrontPortRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"device": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDeviceRequest"
}
]
},
"module": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"enum": [
"8p8c",
"8p6c",
"8p4c",
"8p2c",
"6p6c",
"6p4c",
"6p2c",
"4p4c",
"4p2c",
"gg45",
"tera-4p",
"tera-2p",
"tera-1p",
"110-punch",
"bnc",
"f",
"n",
"mrj21",
"fc",
"fc-pc",
"fc-upc",
"fc-apc",
"lc",
"lc-pc",
"lc-upc",
"lc-apc",
"lsh",
"lsh-pc",
"lsh-upc",
"lsh-apc",
"lx5",
"lx5-pc",
"lx5-upc",
"lx5-apc",
"mpo",
"mtrj",
"sc",
"sc-pc",
"sc-upc",
"sc-apc",
"st",
"cs",
"sn",
"sma-905",
"sma-906",
"urm-p2",
"urm-p4",
"urm-p8",
"splice",
"usb-a",
"usb-b",
"usb-c",
"usb-mini-a",
"usb-mini-b",
"usb-micro-a",
"usb-micro-b",
"usb-micro-ab",
"other"
],
"type": "string",
"description": "* `8p8c` - 8P8C\n* `8p6c` - 8P6C\n* `8p4c` - 8P4C\n* `8p2c` - 8P2C\n* `6p6c` - 6P6C\n* `6p4c` - 6P4C\n* `6p2c` - 6P2C\n* `4p4c` - 4P4C\n* `4p2c` - 4P2C\n* `gg45` - GG45\n* `tera-4p` - TERA 4P\n* `tera-2p` - TERA 2P\n* `tera-1p` - TERA 1P\n* `110-punch` - 110 Punch\n* `bnc` - BNC\n* `f` - F Connector\n* `n` - N Connector\n* `mrj21` - MRJ21\n* `fc` - FC\n* `fc-pc` - FC/PC\n* `fc-upc` - FC/UPC\n* `fc-apc` - FC/APC\n* `lc` - LC\n* `lc-pc` - LC/PC\n* `lc-upc` - LC/UPC\n* `lc-apc` - LC/APC\n* `lsh` - LSH\n* `lsh-pc` - LSH/PC\n* `lsh-upc` - LSH/UPC\n* `lsh-apc` - LSH/APC\n* `lx5` - LX.5\n* `lx5-pc` - LX.5/PC\n* `lx5-upc` - LX.5/UPC\n* `lx5-apc` - LX.5/APC\n* `mpo` - MPO\n* `mtrj` - MTRJ\n* `sc` - SC\n* `sc-pc` - SC/PC\n* `sc-upc` - SC/UPC\n* `sc-apc` - SC/APC\n* `st` - ST\n* `cs` - CS\n* `sn` - SN\n* `sma-905` - SMA 905\n* `sma-906` - SMA 906\n* `urm-p2` - URM-P2\n* `urm-p4` - URM-P4\n* `urm-p8` - URM-P8\n* `splice` - Splice\n* `usb-a` - USB Type A\n* `usb-b` - USB Type B\n* `usb-c` - USB Type C\n* `usb-mini-a` - USB Mini A\n* `usb-mini-b` - USB Mini B\n* `usb-micro-a` - USB Micro A\n* `usb-micro-b` - USB Micro B\n* `usb-micro-ab` - USB Micro AB\n* `other` - Other",
"x-spec-enum-id": "ea67ae8ba4602f8a"
},
"color": {
"type": "string",
"pattern": "^[0-9a-f]{6}$",
"maxLength": 6
},
"rear_port": {
"type": "integer"
},
"rear_port_position": {
"type": "integer",
"maximum": 1024,
"minimum": 1,
"description": "Mapped position on corresponding rear port"
},
"description": {
"type": "string",
"maxLength": 200
},
"mark_connected": {
"type": "boolean",
"description": "Treat as if a cable is connected"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"device",
"name",
"rear_port",
"type"
]
},
"WritableFrontPortTemplateRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"device_type": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefDeviceTypeRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"module_type": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleTypeRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"description": "{module} is accepted as a substitution for the module bay position when attached to a module type.",
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"enum": [
"8p8c",
"8p6c",
"8p4c",
"8p2c",
"6p6c",
"6p4c",
"6p2c",
"4p4c",
"4p2c",
"gg45",
"tera-4p",
"tera-2p",
"tera-1p",
"110-punch",
"bnc",
"f",
"n",
"mrj21",
"fc",
"fc-pc",
"fc-upc",
"fc-apc",
"lc",
"lc-pc",
"lc-upc",
"lc-apc",
"lsh",
"lsh-pc",
"lsh-upc",
"lsh-apc",
"lx5",
"lx5-pc",
"lx5-upc",
"lx5-apc",
"mpo",
"mtrj",
"sc",
"sc-pc",
"sc-upc",
"sc-apc",
"st",
"cs",
"sn",
"sma-905",
"sma-906",
"urm-p2",
"urm-p4",
"urm-p8",
"splice",
"usb-a",
"usb-b",
"usb-c",
"usb-mini-a",
"usb-mini-b",
"usb-micro-a",
"usb-micro-b",
"usb-micro-ab",
"other"
],
"type": "string",
"description": "* `8p8c` - 8P8C\n* `8p6c` - 8P6C\n* `8p4c` - 8P4C\n* `8p2c` - 8P2C\n* `6p6c` - 6P6C\n* `6p4c` - 6P4C\n* `6p2c` - 6P2C\n* `4p4c` - 4P4C\n* `4p2c` - 4P2C\n* `gg45` - GG45\n* `tera-4p` - TERA 4P\n* `tera-2p` - TERA 2P\n* `tera-1p` - TERA 1P\n* `110-punch` - 110 Punch\n* `bnc` - BNC\n* `f` - F Connector\n* `n` - N Connector\n* `mrj21` - MRJ21\n* `fc` - FC\n* `fc-pc` - FC/PC\n* `fc-upc` - FC/UPC\n* `fc-apc` - FC/APC\n* `lc` - LC\n* `lc-pc` - LC/PC\n* `lc-upc` - LC/UPC\n* `lc-apc` - LC/APC\n* `lsh` - LSH\n* `lsh-pc` - LSH/PC\n* `lsh-upc` - LSH/UPC\n* `lsh-apc` - LSH/APC\n* `lx5` - LX.5\n* `lx5-pc` - LX.5/PC\n* `lx5-upc` - LX.5/UPC\n* `lx5-apc` - LX.5/APC\n* `mpo` - MPO\n* `mtrj` - MTRJ\n* `sc` - SC\n* `sc-pc` - SC/PC\n* `sc-upc` - SC/UPC\n* `sc-apc` - SC/APC\n* `st` - ST\n* `cs` - CS\n* `sn` - SN\n* `sma-905` - SMA 905\n* `sma-906` - SMA 906\n* `urm-p2` - URM-P2\n* `urm-p4` - URM-P4\n* `urm-p8` - URM-P8\n* `splice` - Splice\n* `usb-a` - USB Type A\n* `usb-b` - USB Type B\n* `usb-c` - USB Type C\n* `usb-mini-a` - USB Mini A\n* `usb-mini-b` - USB Mini B\n* `usb-micro-a` - USB Micro A\n* `usb-micro-b` - USB Micro B\n* `usb-micro-ab` - USB Micro AB\n* `other` - Other",
"x-spec-enum-id": "ea67ae8ba4602f8a"
},
"color": {
"type": "string",
"pattern": "^[0-9a-f]{6}$",
"maxLength": 6
},
"rear_port": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefRearPortTemplateRequest"
}
]
},
"rear_port_position": {
"type": "integer",
"maximum": 1024,
"minimum": 1
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name",
"rear_port",
"type"
]
},
"WritableIKEPolicyRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"version": {
"enum": [
1,
2
],
"type": "integer",
"description": "* `1` - IKEv1\n* `2` - IKEv2",
"x-spec-enum-id": "00872b77916a1fde",
"minimum": 0,
"maximum": 32767
},
"mode": {
"enum": [
"aggressive",
"main",
"",
null
],
"type": "string",
"description": "* `aggressive` - Aggressive\n* `main` - Main",
"x-spec-enum-id": "64c1be7bdb2548ca",
"nullable": true
},
"proposals": {
"type": "array",
"items": {
"type": "integer"
}
},
"preshared_key": {
"type": "string",
"title": "Pre-shared key"
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name"
]
},
"WritableIKEProposalRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"authentication_method": {
"enum": [
"preshared-keys",
"certificates",
"rsa-signatures",
"dsa-signatures"
],
"type": "string",
"description": "* `preshared-keys` - Pre-shared keys\n* `certificates` - Certificates\n* `rsa-signatures` - RSA signatures\n* `dsa-signatures` - DSA signatures",
"x-spec-enum-id": "92bb2f1103b3a262"
},
"encryption_algorithm": {
"enum": [
"aes-128-cbc",
"aes-128-gcm",
"aes-192-cbc",
"aes-192-gcm",
"aes-256-cbc",
"aes-256-gcm",
"3des-cbc",
"des-cbc"
],
"type": "string",
"description": "* `aes-128-cbc` - 128-bit AES (CBC)\n* `aes-128-gcm` - 128-bit AES (GCM)\n* `aes-192-cbc` - 192-bit AES (CBC)\n* `aes-192-gcm` - 192-bit AES (GCM)\n* `aes-256-cbc` - 256-bit AES (CBC)\n* `aes-256-gcm` - 256-bit AES (GCM)\n* `3des-cbc` - 3DES\n* `des-cbc` - DES",
"x-spec-enum-id": "b022535cfdee79fe"
},
"authentication_algorithm": {
"enum": [
"hmac-sha1",
"hmac-sha256",
"hmac-sha384",
"hmac-sha512",
"hmac-md5",
"",
null
],
"type": "string",
"description": "* `hmac-sha1` - SHA-1 HMAC\n* `hmac-sha256` - SHA-256 HMAC\n* `hmac-sha384` - SHA-384 HMAC\n* `hmac-sha512` - SHA-512 HMAC\n* `hmac-md5` - MD5 HMAC",
"x-spec-enum-id": "0830e8839f5dea4f",
"nullable": true
},
"group": {
"enum": [
1,
2,
5,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34
],
"type": "integer",
"x-spec-enum-id": "dbef43be795462a8",
"description": "Diffie-Hellman group ID\n\n* `1` - Group 1\n* `2` - Group 2\n* `5` - Group 5\n* `14` - Group 14\n* `15` - Group 15\n* `16` - Group 16\n* `17` - Group 17\n* `18` - Group 18\n* `19` - Group 19\n* `20` - Group 20\n* `21` - Group 21\n* `22` - Group 22\n* `23` - Group 23\n* `24` - Group 24\n* `25` - Group 25\n* `26` - Group 26\n* `27` - Group 27\n* `28` - Group 28\n* `29` - Group 29\n* `30` - Group 30\n* `31` - Group 31\n* `32` - Group 32\n* `33` - Group 33\n* `34` - Group 34",
"minimum": 0,
"maximum": 32767
},
"sa_lifetime": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"description": "Security association lifetime (in seconds)"
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"authentication_method",
"encryption_algorithm",
"group",
"name"
]
},
"WritableIPAddressRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"address": {
"type": "string",
"minLength": 1
},
"vrf": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefVRFRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"status": {
"enum": [
"active",
"reserved",
"deprecated",
"dhcp",
"slaac"
],
"type": "string",
"x-spec-enum-id": "24935cfee15bd268",
"description": "The operational status of this IP\n\n* `active` - Active\n* `reserved` - Reserved\n* `deprecated` - Deprecated\n* `dhcp` - DHCP\n* `slaac` - SLAAC"
},
"role": {
"enum": [
"loopback",
"secondary",
"anycast",
"vip",
"vrrp",
"hsrp",
"glbp",
"carp",
"",
null
],
"type": "string",
"x-spec-enum-id": "10fbcb4930889b0f",
"nullable": true,
"description": "The functional role of this IP\n\n* `loopback` - Loopback\n* `secondary` - Secondary\n* `anycast` - Anycast\n* `vip` - VIP\n* `vrrp` - VRRP\n* `hsrp` - HSRP\n* `glbp` - GLBP\n* `carp` - CARP"
},
"assigned_object_type": {
"type": "string",
"nullable": true
},
"assigned_object_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64",
"nullable": true
},
"nat_inside": {
"type": "integer",
"nullable": true,
"title": "NAT (inside)",
"description": "The IP for which this address is the \"outside\" IP"
},
"dns_name": {
"type": "string",
"description": "Hostname or FQDN (not case-sensitive)",
"pattern": "^([0-9A-Za-z_-]+|\\*)(\\.[0-9A-Za-z_-]+)*\\.?$",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"address"
]
},
"WritableIPRangeRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"start_address": {
"type": "string",
"minLength": 1
},
"end_address": {
"type": "string",
"minLength": 1
},
"vrf": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefVRFRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"status": {
"enum": [
"active",
"reserved",
"deprecated"
],
"type": "string",
"x-spec-enum-id": "6388dfb94ca1cc15",
"description": "Operational status of this range\n\n* `active` - Active\n* `reserved` - Reserved\n* `deprecated` - Deprecated"
},
"role": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefRoleRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"mark_populated": {
"type": "boolean",
"description": "Prevent the creation of IP addresses within this range"
},
"mark_utilized": {
"type": "boolean",
"description": "Report space as 100% utilized"
}
},
"required": [
"end_address",
"start_address"
]
},
"WritableIPSecPolicyRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"proposals": {
"type": "array",
"items": {
"type": "integer"
}
},
"pfs_group": {
"enum": [
1,
2,
5,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34,
null
],
"type": "integer",
"x-spec-enum-id": "dbef43be795462a8",
"nullable": true,
"description": "Diffie-Hellman group for Perfect Forward Secrecy\n\n* `1` - Group 1\n* `2` - Group 2\n* `5` - Group 5\n* `14` - Group 14\n* `15` - Group 15\n* `16` - Group 16\n* `17` - Group 17\n* `18` - Group 18\n* `19` - Group 19\n* `20` - Group 20\n* `21` - Group 21\n* `22` - Group 22\n* `23` - Group 23\n* `24` - Group 24\n* `25` - Group 25\n* `26` - Group 26\n* `27` - Group 27\n* `28` - Group 28\n* `29` - Group 29\n* `30` - Group 30\n* `31` - Group 31\n* `32` - Group 32\n* `33` - Group 33\n* `34` - Group 34",
"minimum": 0,
"maximum": 32767
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name"
]
},
"WritableIPSecProfileRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"mode": {
"enum": [
"esp",
"ah"
],
"type": "string",
"description": "* `esp` - ESP\n* `ah` - AH",
"x-spec-enum-id": "1136c2cdfee84436"
},
"ike_policy": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefIKEPolicyRequest"
}
]
},
"ipsec_policy": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefIPSecPolicyRequest"
}
]
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"ike_policy",
"ipsec_policy",
"mode",
"name"
]
},
"WritableIPSecProposalRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 200
},
"encryption_algorithm": {
"enum": [
"aes-128-cbc",
"aes-128-gcm",
"aes-192-cbc",
"aes-192-gcm",
"aes-256-cbc",
"aes-256-gcm",
"3des-cbc",
"des-cbc",
"",
null
],
"type": "string",
"description": "* `aes-128-cbc` - 128-bit AES (CBC)\n* `aes-128-gcm` - 128-bit AES (GCM)\n* `aes-192-cbc` - 192-bit AES (CBC)\n* `aes-192-gcm` - 192-bit AES (GCM)\n* `aes-256-cbc` - 256-bit AES (CBC)\n* `aes-256-gcm` - 256-bit AES (GCM)\n* `3des-cbc` - 3DES\n* `des-cbc` - DES",
"x-spec-enum-id": "b022535cfdee79fe",
"nullable": true,
"title": "Encryption"
},
"authentication_algorithm": {
"enum": [
"hmac-sha1",
"hmac-sha256",
"hmac-sha384",
"hmac-sha512",
"hmac-md5",
"",
null
],
"type": "string",
"description": "* `hmac-sha1` - SHA-1 HMAC\n* `hmac-sha256` - SHA-256 HMAC\n* `hmac-sha384` - SHA-384 HMAC\n* `hmac-sha512` - SHA-512 HMAC\n* `hmac-md5` - MD5 HMAC",
"x-spec-enum-id": "0830e8839f5dea4f",
"nullable": true,
"title": "Authentication"
},
"sa_lifetime_seconds": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"title": "SA lifetime (seconds)",
"description": "Security association lifetime (seconds)"
},
"sa_lifetime_data": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"title": "SA lifetime (KB)",
"description": "Security association lifetime (in kilobytes)"
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name"
]
},
"WritableInterfaceRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"device": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDeviceRequest"
}
]
},
"vdcs": {
"type": "array",
"items": {
"type": "integer"
}
},
"module": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"enum": [
"virtual",
"bridge",
"lag",
"100base-fx",
"100base-lfx",
"100base-tx",
"100base-t1",
"1000base-t",
"1000base-sx",
"1000base-lx",
"1000base-tx",
"2.5gbase-t",
"5gbase-t",
"10gbase-t",
"10gbase-cx4",
"100base-x-sfp",
"1000base-x-gbic",
"1000base-x-sfp",
"10gbase-x-sfpp",
"10gbase-x-xfp",
"10gbase-x-xenpak",
"10gbase-x-x2",
"25gbase-x-sfp28",
"50gbase-x-sfp56",
"40gbase-x-qsfpp",
"50gbase-x-sfp28",
"100gbase-x-cfp",
"100gbase-x-cfp2",
"200gbase-x-cfp2",
"400gbase-x-cfp2",
"100gbase-x-cfp4",
"100gbase-x-cxp",
"100gbase-x-cpak",
"100gbase-x-dsfp",
"100gbase-x-sfpdd",
"100gbase-x-qsfp28",
"100gbase-x-qsfpdd",
"200gbase-x-qsfp56",
"200gbase-x-qsfpdd",
"400gbase-x-qsfp112",
"400gbase-x-qsfpdd",
"400gbase-x-osfp",
"400gbase-x-osfp-rhs",
"400gbase-x-cdfp",
"400gbase-x-cfp8",
"800gbase-x-qsfpdd",
"800gbase-x-osfp",
"1000base-kx",
"2.5gbase-kx",
"5gbase-kr",
"10gbase-kr",
"10gbase-kx4",
"25gbase-kr",
"40gbase-kr4",
"50gbase-kr",
"100gbase-kp4",
"100gbase-kr2",
"100gbase-kr4",
"ieee802.11a",
"ieee802.11g",
"ieee802.11n",
"ieee802.11ac",
"ieee802.11ad",
"ieee802.11ax",
"ieee802.11ay",
"ieee802.11be",
"ieee802.15.1",
"ieee802.15.4",
"other-wireless",
"gsm",
"cdma",
"lte",
"4g",
"5g",
"sonet-oc3",
"sonet-oc12",
"sonet-oc48",
"sonet-oc192",
"sonet-oc768",
"sonet-oc1920",
"sonet-oc3840",
"1gfc-sfp",
"2gfc-sfp",
"4gfc-sfp",
"8gfc-sfpp",
"16gfc-sfpp",
"32gfc-sfp28",
"32gfc-sfpp",
"64gfc-qsfpp",
"64gfc-sfpdd",
"64gfc-sfpp",
"128gfc-qsfp28",
"infiniband-sdr",
"infiniband-ddr",
"infiniband-qdr",
"infiniband-fdr10",
"infiniband-fdr",
"infiniband-edr",
"infiniband-hdr",
"infiniband-ndr",
"infiniband-xdr",
"t1",
"e1",
"t3",
"e3",
"xdsl",
"docsis",
"moca",
"bpon",
"epon",
"10g-epon",
"gpon",
"xg-pon",
"xgs-pon",
"ng-pon2",
"25g-pon",
"50g-pon",
"cisco-stackwise",
"cisco-stackwise-plus",
"cisco-flexstack",
"cisco-flexstack-plus",
"cisco-stackwise-80",
"cisco-stackwise-160",
"cisco-stackwise-320",
"cisco-stackwise-480",
"cisco-stackwise-1t",
"juniper-vcp",
"extreme-summitstack",
"extreme-summitstack-128",
"extreme-summitstack-256",
"extreme-summitstack-512",
"other"
],
"type": "string",
"description": "* `virtual` - Virtual\n* `bridge` - Bridge\n* `lag` - Link Aggregation Group (LAG)\n* `100base-fx` - 100BASE-FX (10/100ME FIBER)\n* `100base-lfx` - 100BASE-LFX (10/100ME FIBER)\n* `100base-tx` - 100BASE-TX (10/100ME)\n* `100base-t1` - 100BASE-T1 (10/100ME Single Pair)\n* `1000base-t` - 1000BASE-T (1GE)\n* `1000base-sx` - 1000BASE-SX (1GE)\n* `1000base-lx` - 1000BASE-LX (1GE)\n* `1000base-tx` - 1000BASE-TX (1GE)\n* `2.5gbase-t` - 2.5GBASE-T (2.5GE)\n* `5gbase-t` - 5GBASE-T (5GE)\n* `10gbase-t` - 10GBASE-T (10GE)\n* `10gbase-cx4` - 10GBASE-CX4 (10GE)\n* `100base-x-sfp` - SFP (100ME)\n* `1000base-x-gbic` - GBIC (1GE)\n* `1000base-x-sfp` - SFP (1GE)\n* `10gbase-x-sfpp` - SFP+ (10GE)\n* `10gbase-x-xfp` - XFP (10GE)\n* `10gbase-x-xenpak` - XENPAK (10GE)\n* `10gbase-x-x2` - X2 (10GE)\n* `25gbase-x-sfp28` - SFP28 (25GE)\n* `50gbase-x-sfp56` - SFP56 (50GE)\n* `40gbase-x-qsfpp` - QSFP+ (40GE)\n* `50gbase-x-sfp28` - QSFP28 (50GE)\n* `100gbase-x-cfp` - CFP (100GE)\n* `100gbase-x-cfp2` - CFP2 (100GE)\n* `200gbase-x-cfp2` - CFP2 (200GE)\n* `400gbase-x-cfp2` - CFP2 (400GE)\n* `100gbase-x-cfp4` - CFP4 (100GE)\n* `100gbase-x-cxp` - CXP (100GE)\n* `100gbase-x-cpak` - Cisco CPAK (100GE)\n* `100gbase-x-dsfp` - DSFP (100GE)\n* `100gbase-x-sfpdd` - SFP-DD (100GE)\n* `100gbase-x-qsfp28` - QSFP28 (100GE)\n* `100gbase-x-qsfpdd` - QSFP-DD (100GE)\n* `200gbase-x-qsfp56` - QSFP56 (200GE)\n* `200gbase-x-qsfpdd` - QSFP-DD (200GE)\n* `400gbase-x-qsfp112` - QSFP112 (400GE)\n* `400gbase-x-qsfpdd` - QSFP-DD (400GE)\n* `400gbase-x-osfp` - OSFP (400GE)\n* `400gbase-x-osfp-rhs` - OSFP-RHS (400GE)\n* `400gbase-x-cdfp` - CDFP (400GE)\n* `400gbase-x-cfp8` - CPF8 (400GE)\n* `800gbase-x-qsfpdd` - QSFP-DD (800GE)\n* `800gbase-x-osfp` - OSFP (800GE)\n* `1000base-kx` - 1000BASE-KX (1GE)\n* `2.5gbase-kx` - 2.5GBASE-KX (2.5GE)\n* `5gbase-kr` - 5GBASE-KR (5GE)\n* `10gbase-kr` - 10GBASE-KR (10GE)\n* `10gbase-kx4` - 10GBASE-KX4 (10GE)\n* `25gbase-kr` - 25GBASE-KR (25GE)\n* `40gbase-kr4` - 40GBASE-KR4 (40GE)\n* `50gbase-kr` - 50GBASE-KR (50GE)\n* `100gbase-kp4` - 100GBASE-KP4 (100GE)\n* `100gbase-kr2` - 100GBASE-KR2 (100GE)\n* `100gbase-kr4` - 100GBASE-KR4 (100GE)\n* `ieee802.11a` - IEEE 802.11a\n* `ieee802.11g` - IEEE 802.11b/g\n* `ieee802.11n` - IEEE 802.11n\n* `ieee802.11ac` - IEEE 802.11ac\n* `ieee802.11ad` - IEEE 802.11ad\n* `ieee802.11ax` - IEEE 802.11ax\n* `ieee802.11ay` - IEEE 802.11ay\n* `ieee802.11be` - IEEE 802.11be\n* `ieee802.15.1` - IEEE 802.15.1 (Bluetooth)\n* `ieee802.15.4` - IEEE 802.15.4 (LR-WPAN)\n* `other-wireless` - Other (Wireless)\n* `gsm` - GSM\n* `cdma` - CDMA\n* `lte` - LTE\n* `4g` - 4G\n* `5g` - 5G\n* `sonet-oc3` - OC-3/STM-1\n* `sonet-oc12` - OC-12/STM-4\n* `sonet-oc48` - OC-48/STM-16\n* `sonet-oc192` - OC-192/STM-64\n* `sonet-oc768` - OC-768/STM-256\n* `sonet-oc1920` - OC-1920/STM-640\n* `sonet-oc3840` - OC-3840/STM-1234\n* `1gfc-sfp` - SFP (1GFC)\n* `2gfc-sfp` - SFP (2GFC)\n* `4gfc-sfp` - SFP (4GFC)\n* `8gfc-sfpp` - SFP+ (8GFC)\n* `16gfc-sfpp` - SFP+ (16GFC)\n* `32gfc-sfp28` - SFP28 (32GFC)\n* `32gfc-sfpp` - SFP+ (32GFC)\n* `64gfc-qsfpp` - QSFP+ (64GFC)\n* `64gfc-sfpdd` - SFP-DD (64GFC)\n* `64gfc-sfpp` - SFP+ (64GFC)\n* `128gfc-qsfp28` - QSFP28 (128GFC)\n* `infiniband-sdr` - SDR (2 Gbps)\n* `infiniband-ddr` - DDR (4 Gbps)\n* `infiniband-qdr` - QDR (8 Gbps)\n* `infiniband-fdr10` - FDR10 (10 Gbps)\n* `infiniband-fdr` - FDR (13.5 Gbps)\n* `infiniband-edr` - EDR (25 Gbps)\n* `infiniband-hdr` - HDR (50 Gbps)\n* `infiniband-ndr` - NDR (100 Gbps)\n* `infiniband-xdr` - XDR (250 Gbps)\n* `t1` - T1 (1.544 Mbps)\n* `e1` - E1 (2.048 Mbps)\n* `t3` - T3 (45 Mbps)\n* `e3` - E3 (34 Mbps)\n* `xdsl` - xDSL\n* `docsis` - DOCSIS\n* `moca` - MoCA\n* `bpon` - BPON (622 Mbps / 155 Mbps)\n* `epon` - EPON (1 Gbps)\n* `10g-epon` - 10G-EPON (10 Gbps)\n* `gpon` - GPON (2.5 Gbps / 1.25 Gbps)\n* `xg-pon` - XG-PON (10 Gbps / 2.5 Gbps)\n* `xgs-pon` - XGS-PON (10 Gbps)\n* `ng-pon2` - NG-PON2 (TWDM-PON) (4x10 Gbps)\n* `25g-pon` - 25G-PON (25 Gbps)\n* `50g-pon` - 50G-PON (50 Gbps)\n* `cisco-stackwise` - Cisco StackWise\n* `cisco-stackwise-plus` - Cisco StackWise Plus\n* `cisco-flexstack` - Cisco FlexStack\n* `cisco-flexstack-plus` - Cisco FlexStack Plus\n* `cisco-stackwise-80` - Cisco StackWise-80\n* `cisco-stackwise-160` - Cisco StackWise-160\n* `cisco-stackwise-320` - Cisco StackWise-320\n* `cisco-stackwise-480` - Cisco StackWise-480\n* `cisco-stackwise-1t` - Cisco StackWise-1T\n* `juniper-vcp` - Juniper VCP\n* `extreme-summitstack` - Extreme SummitStack\n* `extreme-summitstack-128` - Extreme SummitStack-128\n* `extreme-summitstack-256` - Extreme SummitStack-256\n* `extreme-summitstack-512` - Extreme SummitStack-512\n* `other` - Other",
"x-spec-enum-id": "8c4c5e112f77a383"
},
"enabled": {
"type": "boolean"
},
"parent": {
"type": "integer",
"nullable": true,
"title": "Parent interface"
},
"bridge": {
"type": "integer",
"nullable": true,
"title": "Bridge interface"
},
"lag": {
"type": "integer",
"nullable": true,
"title": "Parent LAG"
},
"mtu": {
"type": "integer",
"maximum": 65536,
"minimum": 1,
"nullable": true
},
"primary_mac_address": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefMACAddressRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"speed": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"title": "Speed (Kbps)"
},
"duplex": {
"enum": [
"half",
"full",
"auto",
"",
null
],
"type": "string",
"description": "* `half` - Half\n* `full` - Full\n* `auto` - Auto",
"x-spec-enum-id": "47eab9b1a65a1e21",
"nullable": true
},
"wwn": {
"type": "string",
"nullable": true
},
"mgmt_only": {
"type": "boolean",
"title": "Management only",
"description": "This interface is used only for out-of-band management"
},
"description": {
"type": "string",
"maxLength": 200
},
"mode": {
"enum": [
"access",
"tagged",
"tagged-all",
"q-in-q",
"",
null
],
"type": "string",
"x-spec-enum-id": "b6fe48fe21dbf01d",
"nullable": true,
"description": "IEEE 802.1Q tagging strategy\n\n* `access` - Access\n* `tagged` - Tagged\n* `tagged-all` - Tagged (All)\n* `q-in-q` - Q-in-Q (802.1ad)"
},
"rf_role": {
"enum": [
"ap",
"station",
"",
null
],
"type": "string",
"description": "* `ap` - Access point\n* `station` - Station",
"x-spec-enum-id": "d2772dbea88b0fb1",
"nullable": true,
"title": "Wireless role"
},
"rf_channel": {
"enum": [
"2.4g-1-2412-22",
"2.4g-2-2417-22",
"2.4g-3-2422-22",
"2.4g-4-2427-22",
"2.4g-5-2432-22",
"2.4g-6-2437-22",
"2.4g-7-2442-22",
"2.4g-8-2447-22",
"2.4g-9-2452-22",
"2.4g-10-2457-22",
"2.4g-11-2462-22",
"2.4g-12-2467-22",
"2.4g-13-2472-22",
"5g-32-5160-20",
"5g-34-5170-40",
"5g-36-5180-20",
"5g-38-5190-40",
"5g-40-5200-20",
"5g-42-5210-80",
"5g-44-5220-20",
"5g-46-5230-40",
"5g-48-5240-20",
"5g-50-5250-160",
"5g-52-5260-20",
"5g-54-5270-40",
"5g-56-5280-20",
"5g-58-5290-80",
"5g-60-5300-20",
"5g-62-5310-40",
"5g-64-5320-20",
"5g-100-5500-20",
"5g-102-5510-40",
"5g-104-5520-20",
"5g-106-5530-80",
"5g-108-5540-20",
"5g-110-5550-40",
"5g-112-5560-20",
"5g-114-5570-160",
"5g-116-5580-20",
"5g-118-5590-40",
"5g-120-5600-20",
"5g-122-5610-80",
"5g-124-5620-20",
"5g-126-5630-40",
"5g-128-5640-20",
"5g-132-5660-20",
"5g-134-5670-40",
"5g-136-5680-20",
"5g-138-5690-80",
"5g-140-5700-20",
"5g-142-5710-40",
"5g-144-5720-20",
"5g-149-5745-20",
"5g-151-5755-40",
"5g-153-5765-20",
"5g-155-5775-80",
"5g-157-5785-20",
"5g-159-5795-40",
"5g-161-5805-20",
"5g-163-5815-160",
"5g-165-5825-20",
"5g-167-5835-40",
"5g-169-5845-20",
"5g-171-5855-80",
"5g-173-5865-20",
"5g-175-5875-40",
"5g-177-5885-20",
"6g-1-5955-20",
"6g-3-5965-40",
"6g-5-5975-20",
"6g-7-5985-80",
"6g-9-5995-20",
"6g-11-6005-40",
"6g-13-6015-20",
"6g-15-6025-160",
"6g-17-6035-20",
"6g-19-6045-40",
"6g-21-6055-20",
"6g-23-6065-80",
"6g-25-6075-20",
"6g-27-6085-40",
"6g-29-6095-20",
"6g-31-6105-320",
"6g-33-6115-20",
"6g-35-6125-40",
"6g-37-6135-20",
"6g-39-6145-80",
"6g-41-6155-20",
"6g-43-6165-40",
"6g-45-6175-20",
"6g-47-6185-160",
"6g-49-6195-20",
"6g-51-6205-40",
"6g-53-6215-20",
"6g-55-6225-80",
"6g-57-6235-20",
"6g-59-6245-40",
"6g-61-6255-20",
"6g-65-6275-20",
"6g-67-6285-40",
"6g-69-6295-20",
"6g-71-6305-80",
"6g-73-6315-20",
"6g-75-6325-40",
"6g-77-6335-20",
"6g-79-6345-160",
"6g-81-6355-20",
"6g-83-6365-40",
"6g-85-6375-20",
"6g-87-6385-80",
"6g-89-6395-20",
"6g-91-6405-40",
"6g-93-6415-20",
"6g-95-6425-320",
"6g-97-6435-20",
"6g-99-6445-40",
"6g-101-6455-20",
"6g-103-6465-80",
"6g-105-6475-20",
"6g-107-6485-40",
"6g-109-6495-20",
"6g-111-6505-160",
"6g-113-6515-20",
"6g-115-6525-40",
"6g-117-6535-20",
"6g-119-6545-80",
"6g-121-6555-20",
"6g-123-6565-40",
"6g-125-6575-20",
"6g-129-6595-20",
"6g-131-6605-40",
"6g-133-6615-20",
"6g-135-6625-80",
"6g-137-6635-20",
"6g-139-6645-40",
"6g-141-6655-20",
"6g-143-6665-160",
"6g-145-6675-20",
"6g-147-6685-40",
"6g-149-6695-20",
"6g-151-6705-80",
"6g-153-6715-20",
"6g-155-6725-40",
"6g-157-6735-20",
"6g-159-6745-320",
"6g-161-6755-20",
"6g-163-6765-40",
"6g-165-6775-20",
"6g-167-6785-80",
"6g-169-6795-20",
"6g-171-6805-40",
"6g-173-6815-20",
"6g-175-6825-160",
"6g-177-6835-20",
"6g-179-6845-40",
"6g-181-6855-20",
"6g-183-6865-80",
"6g-185-6875-20",
"6g-187-6885-40",
"6g-189-6895-20",
"6g-193-6915-20",
"6g-195-6925-40",
"6g-197-6935-20",
"6g-199-6945-80",
"6g-201-6955-20",
"6g-203-6965-40",
"6g-205-6975-20",
"6g-207-6985-160",
"6g-209-6995-20",
"6g-211-7005-40",
"6g-213-7015-20",
"6g-215-7025-80",
"6g-217-7035-20",
"6g-219-7045-40",
"6g-221-7055-20",
"6g-225-7075-20",
"6g-227-7085-40",
"6g-229-7095-20",
"6g-233-7115-20",
"60g-1-58320-2160",
"60g-2-60480-2160",
"60g-3-62640-2160",
"60g-4-64800-2160",
"60g-5-66960-2160",
"60g-6-69120-2160",
"60g-9-59400-4320",
"60g-10-61560-4320",
"60g-11-63720-4320",
"60g-12-65880-4320",
"60g-13-68040-4320",
"60g-17-60480-6480",
"60g-18-62640-6480",
"60g-19-64800-6480",
"60g-20-66960-6480",
"60g-25-61560-6480",
"60g-26-63720-6480",
"60g-27-65880-6480",
"",
null
],
"type": "string",
"description": "* `2.4g-1-2412-22` - 1 (2412 MHz)\n* `2.4g-2-2417-22` - 2 (2417 MHz)\n* `2.4g-3-2422-22` - 3 (2422 MHz)\n* `2.4g-4-2427-22` - 4 (2427 MHz)\n* `2.4g-5-2432-22` - 5 (2432 MHz)\n* `2.4g-6-2437-22` - 6 (2437 MHz)\n* `2.4g-7-2442-22` - 7 (2442 MHz)\n* `2.4g-8-2447-22` - 8 (2447 MHz)\n* `2.4g-9-2452-22` - 9 (2452 MHz)\n* `2.4g-10-2457-22` - 10 (2457 MHz)\n* `2.4g-11-2462-22` - 11 (2462 MHz)\n* `2.4g-12-2467-22` - 12 (2467 MHz)\n* `2.4g-13-2472-22` - 13 (2472 MHz)\n* `5g-32-5160-20` - 32 (5160/20 MHz)\n* `5g-34-5170-40` - 34 (5170/40 MHz)\n* `5g-36-5180-20` - 36 (5180/20 MHz)\n* `5g-38-5190-40` - 38 (5190/40 MHz)\n* `5g-40-5200-20` - 40 (5200/20 MHz)\n* `5g-42-5210-80` - 42 (5210/80 MHz)\n* `5g-44-5220-20` - 44 (5220/20 MHz)\n* `5g-46-5230-40` - 46 (5230/40 MHz)\n* `5g-48-5240-20` - 48 (5240/20 MHz)\n* `5g-50-5250-160` - 50 (5250/160 MHz)\n* `5g-52-5260-20` - 52 (5260/20 MHz)\n* `5g-54-5270-40` - 54 (5270/40 MHz)\n* `5g-56-5280-20` - 56 (5280/20 MHz)\n* `5g-58-5290-80` - 58 (5290/80 MHz)\n* `5g-60-5300-20` - 60 (5300/20 MHz)\n* `5g-62-5310-40` - 62 (5310/40 MHz)\n* `5g-64-5320-20` - 64 (5320/20 MHz)\n* `5g-100-5500-20` - 100 (5500/20 MHz)\n* `5g-102-5510-40` - 102 (5510/40 MHz)\n* `5g-104-5520-20` - 104 (5520/20 MHz)\n* `5g-106-5530-80` - 106 (5530/80 MHz)\n* `5g-108-5540-20` - 108 (5540/20 MHz)\n* `5g-110-5550-40` - 110 (5550/40 MHz)\n* `5g-112-5560-20` - 112 (5560/20 MHz)\n* `5g-114-5570-160` - 114 (5570/160 MHz)\n* `5g-116-5580-20` - 116 (5580/20 MHz)\n* `5g-118-5590-40` - 118 (5590/40 MHz)\n* `5g-120-5600-20` - 120 (5600/20 MHz)\n* `5g-122-5610-80` - 122 (5610/80 MHz)\n* `5g-124-5620-20` - 124 (5620/20 MHz)\n* `5g-126-5630-40` - 126 (5630/40 MHz)\n* `5g-128-5640-20` - 128 (5640/20 MHz)\n* `5g-132-5660-20` - 132 (5660/20 MHz)\n* `5g-134-5670-40` - 134 (5670/40 MHz)\n* `5g-136-5680-20` - 136 (5680/20 MHz)\n* `5g-138-5690-80` - 138 (5690/80 MHz)\n* `5g-140-5700-20` - 140 (5700/20 MHz)\n* `5g-142-5710-40` - 142 (5710/40 MHz)\n* `5g-144-5720-20` - 144 (5720/20 MHz)\n* `5g-149-5745-20` - 149 (5745/20 MHz)\n* `5g-151-5755-40` - 151 (5755/40 MHz)\n* `5g-153-5765-20` - 153 (5765/20 MHz)\n* `5g-155-5775-80` - 155 (5775/80 MHz)\n* `5g-157-5785-20` - 157 (5785/20 MHz)\n* `5g-159-5795-40` - 159 (5795/40 MHz)\n* `5g-161-5805-20` - 161 (5805/20 MHz)\n* `5g-163-5815-160` - 163 (5815/160 MHz)\n* `5g-165-5825-20` - 165 (5825/20 MHz)\n* `5g-167-5835-40` - 167 (5835/40 MHz)\n* `5g-169-5845-20` - 169 (5845/20 MHz)\n* `5g-171-5855-80` - 171 (5855/80 MHz)\n* `5g-173-5865-20` - 173 (5865/20 MHz)\n* `5g-175-5875-40` - 175 (5875/40 MHz)\n* `5g-177-5885-20` - 177 (5885/20 MHz)\n* `6g-1-5955-20` - 1 (5955/20 MHz)\n* `6g-3-5965-40` - 3 (5965/40 MHz)\n* `6g-5-5975-20` - 5 (5975/20 MHz)\n* `6g-7-5985-80` - 7 (5985/80 MHz)\n* `6g-9-5995-20` - 9 (5995/20 MHz)\n* `6g-11-6005-40` - 11 (6005/40 MHz)\n* `6g-13-6015-20` - 13 (6015/20 MHz)\n* `6g-15-6025-160` - 15 (6025/160 MHz)\n* `6g-17-6035-20` - 17 (6035/20 MHz)\n* `6g-19-6045-40` - 19 (6045/40 MHz)\n* `6g-21-6055-20` - 21 (6055/20 MHz)\n* `6g-23-6065-80` - 23 (6065/80 MHz)\n* `6g-25-6075-20` - 25 (6075/20 MHz)\n* `6g-27-6085-40` - 27 (6085/40 MHz)\n* `6g-29-6095-20` - 29 (6095/20 MHz)\n* `6g-31-6105-320` - 31 (6105/320 MHz)\n* `6g-33-6115-20` - 33 (6115/20 MHz)\n* `6g-35-6125-40` - 35 (6125/40 MHz)\n* `6g-37-6135-20` - 37 (6135/20 MHz)\n* `6g-39-6145-80` - 39 (6145/80 MHz)\n* `6g-41-6155-20` - 41 (6155/20 MHz)\n* `6g-43-6165-40` - 43 (6165/40 MHz)\n* `6g-45-6175-20` - 45 (6175/20 MHz)\n* `6g-47-6185-160` - 47 (6185/160 MHz)\n* `6g-49-6195-20` - 49 (6195/20 MHz)\n* `6g-51-6205-40` - 51 (6205/40 MHz)\n* `6g-53-6215-20` - 53 (6215/20 MHz)\n* `6g-55-6225-80` - 55 (6225/80 MHz)\n* `6g-57-6235-20` - 57 (6235/20 MHz)\n* `6g-59-6245-40` - 59 (6245/40 MHz)\n* `6g-61-6255-20` - 61 (6255/20 MHz)\n* `6g-65-6275-20` - 65 (6275/20 MHz)\n* `6g-67-6285-40` - 67 (6285/40 MHz)\n* `6g-69-6295-20` - 69 (6295/20 MHz)\n* `6g-71-6305-80` - 71 (6305/80 MHz)\n* `6g-73-6315-20` - 73 (6315/20 MHz)\n* `6g-75-6325-40` - 75 (6325/40 MHz)\n* `6g-77-6335-20` - 77 (6335/20 MHz)\n* `6g-79-6345-160` - 79 (6345/160 MHz)\n* `6g-81-6355-20` - 81 (6355/20 MHz)\n* `6g-83-6365-40` - 83 (6365/40 MHz)\n* `6g-85-6375-20` - 85 (6375/20 MHz)\n* `6g-87-6385-80` - 87 (6385/80 MHz)\n* `6g-89-6395-20` - 89 (6395/20 MHz)\n* `6g-91-6405-40` - 91 (6405/40 MHz)\n* `6g-93-6415-20` - 93 (6415/20 MHz)\n* `6g-95-6425-320` - 95 (6425/320 MHz)\n* `6g-97-6435-20` - 97 (6435/20 MHz)\n* `6g-99-6445-40` - 99 (6445/40 MHz)\n* `6g-101-6455-20` - 101 (6455/20 MHz)\n* `6g-103-6465-80` - 103 (6465/80 MHz)\n* `6g-105-6475-20` - 105 (6475/20 MHz)\n* `6g-107-6485-40` - 107 (6485/40 MHz)\n* `6g-109-6495-20` - 109 (6495/20 MHz)\n* `6g-111-6505-160` - 111 (6505/160 MHz)\n* `6g-113-6515-20` - 113 (6515/20 MHz)\n* `6g-115-6525-40` - 115 (6525/40 MHz)\n* `6g-117-6535-20` - 117 (6535/20 MHz)\n* `6g-119-6545-80` - 119 (6545/80 MHz)\n* `6g-121-6555-20` - 121 (6555/20 MHz)\n* `6g-123-6565-40` - 123 (6565/40 MHz)\n* `6g-125-6575-20` - 125 (6575/20 MHz)\n* `6g-129-6595-20` - 129 (6595/20 MHz)\n* `6g-131-6605-40` - 131 (6605/40 MHz)\n* `6g-133-6615-20` - 133 (6615/20 MHz)\n* `6g-135-6625-80` - 135 (6625/80 MHz)\n* `6g-137-6635-20` - 137 (6635/20 MHz)\n* `6g-139-6645-40` - 139 (6645/40 MHz)\n* `6g-141-6655-20` - 141 (6655/20 MHz)\n* `6g-143-6665-160` - 143 (6665/160 MHz)\n* `6g-145-6675-20` - 145 (6675/20 MHz)\n* `6g-147-6685-40` - 147 (6685/40 MHz)\n* `6g-149-6695-20` - 149 (6695/20 MHz)\n* `6g-151-6705-80` - 151 (6705/80 MHz)\n* `6g-153-6715-20` - 153 (6715/20 MHz)\n* `6g-155-6725-40` - 155 (6725/40 MHz)\n* `6g-157-6735-20` - 157 (6735/20 MHz)\n* `6g-159-6745-320` - 159 (6745/320 MHz)\n* `6g-161-6755-20` - 161 (6755/20 MHz)\n* `6g-163-6765-40` - 163 (6765/40 MHz)\n* `6g-165-6775-20` - 165 (6775/20 MHz)\n* `6g-167-6785-80` - 167 (6785/80 MHz)\n* `6g-169-6795-20` - 169 (6795/20 MHz)\n* `6g-171-6805-40` - 171 (6805/40 MHz)\n* `6g-173-6815-20` - 173 (6815/20 MHz)\n* `6g-175-6825-160` - 175 (6825/160 MHz)\n* `6g-177-6835-20` - 177 (6835/20 MHz)\n* `6g-179-6845-40` - 179 (6845/40 MHz)\n* `6g-181-6855-20` - 181 (6855/20 MHz)\n* `6g-183-6865-80` - 183 (6865/80 MHz)\n* `6g-185-6875-20` - 185 (6875/20 MHz)\n* `6g-187-6885-40` - 187 (6885/40 MHz)\n* `6g-189-6895-20` - 189 (6895/20 MHz)\n* `6g-193-6915-20` - 193 (6915/20 MHz)\n* `6g-195-6925-40` - 195 (6925/40 MHz)\n* `6g-197-6935-20` - 197 (6935/20 MHz)\n* `6g-199-6945-80` - 199 (6945/80 MHz)\n* `6g-201-6955-20` - 201 (6955/20 MHz)\n* `6g-203-6965-40` - 203 (6965/40 MHz)\n* `6g-205-6975-20` - 205 (6975/20 MHz)\n* `6g-207-6985-160` - 207 (6985/160 MHz)\n* `6g-209-6995-20` - 209 (6995/20 MHz)\n* `6g-211-7005-40` - 211 (7005/40 MHz)\n* `6g-213-7015-20` - 213 (7015/20 MHz)\n* `6g-215-7025-80` - 215 (7025/80 MHz)\n* `6g-217-7035-20` - 217 (7035/20 MHz)\n* `6g-219-7045-40` - 219 (7045/40 MHz)\n* `6g-221-7055-20` - 221 (7055/20 MHz)\n* `6g-225-7075-20` - 225 (7075/20 MHz)\n* `6g-227-7085-40` - 227 (7085/40 MHz)\n* `6g-229-7095-20` - 229 (7095/20 MHz)\n* `6g-233-7115-20` - 233 (7115/20 MHz)\n* `60g-1-58320-2160` - 1 (58.32/2.16 GHz)\n* `60g-2-60480-2160` - 2 (60.48/2.16 GHz)\n* `60g-3-62640-2160` - 3 (62.64/2.16 GHz)\n* `60g-4-64800-2160` - 4 (64.80/2.16 GHz)\n* `60g-5-66960-2160` - 5 (66.96/2.16 GHz)\n* `60g-6-69120-2160` - 6 (69.12/2.16 GHz)\n* `60g-9-59400-4320` - 9 (59.40/4.32 GHz)\n* `60g-10-61560-4320` - 10 (61.56/4.32 GHz)\n* `60g-11-63720-4320` - 11 (63.72/4.32 GHz)\n* `60g-12-65880-4320` - 12 (65.88/4.32 GHz)\n* `60g-13-68040-4320` - 13 (68.04/4.32 GHz)\n* `60g-17-60480-6480` - 17 (60.48/6.48 GHz)\n* `60g-18-62640-6480` - 18 (62.64/6.48 GHz)\n* `60g-19-64800-6480` - 19 (64.80/6.48 GHz)\n* `60g-20-66960-6480` - 20 (66.96/6.48 GHz)\n* `60g-25-61560-6480` - 25 (61.56/8.64 GHz)\n* `60g-26-63720-6480` - 26 (63.72/8.64 GHz)\n* `60g-27-65880-6480` - 27 (65.88/8.64 GHz)",
"x-spec-enum-id": "aac33cc237adc8f9",
"nullable": true,
"title": "Wireless channel"
},
"poe_mode": {
"enum": [
"pd",
"pse",
"",
null
],
"type": "string",
"description": "* `pd` - PD\n* `pse` - PSE",
"x-spec-enum-id": "2f2fe6dcdc7772bd",
"nullable": true
},
"poe_type": {
"enum": [
"type1-ieee802.3af",
"type2-ieee802.3at",
"type3-ieee802.3bt",
"type4-ieee802.3bt",
"passive-24v-2pair",
"passive-24v-4pair",
"passive-48v-2pair",
"passive-48v-4pair",
"",
null
],
"type": "string",
"description": "* `type1-ieee802.3af` - 802.3af (Type 1)\n* `type2-ieee802.3at` - 802.3at (Type 2)\n* `type3-ieee802.3bt` - 802.3bt (Type 3)\n* `type4-ieee802.3bt` - 802.3bt (Type 4)\n* `passive-24v-2pair` - Passive 24V (2-pair)\n* `passive-24v-4pair` - Passive 24V (4-pair)\n* `passive-48v-2pair` - Passive 48V (2-pair)\n* `passive-48v-4pair` - Passive 48V (4-pair)",
"x-spec-enum-id": "74bd3be4012f6da9",
"nullable": true
},
"rf_channel_frequency": {
"type": "number",
"format": "double",
"maximum": 100000,
"minimum": -100000,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true,
"title": "Channel frequency (MHz)",
"description": "Populated by selected channel (if set)"
},
"rf_channel_width": {
"type": "number",
"format": "double",
"maximum": 10000,
"minimum": -10000,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true,
"title": "Channel width (MHz)",
"description": "Populated by selected channel (if set)"
},
"tx_power": {
"type": "integer",
"maximum": 127,
"minimum": -40,
"nullable": true,
"title": "Transmit power (dBm)"
},
"untagged_vlan": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefVLANRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"tagged_vlans": {
"type": "array",
"items": {
"type": "integer"
}
},
"qinq_svlan": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefVLANRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"vlan_translation_policy": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefVLANTranslationPolicyRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"mark_connected": {
"type": "boolean",
"description": "Treat as if a cable is connected"
},
"wireless_lans": {
"type": "array",
"items": {
"type": "integer"
}
},
"vrf": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefVRFRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"device",
"name",
"type"
]
},
"WritableInterfaceTemplateRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"device_type": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefDeviceTypeRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"module_type": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleTypeRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"description": "{module} is accepted as a substitution for the module bay position when attached to a module type.",
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"enum": [
"virtual",
"bridge",
"lag",
"100base-fx",
"100base-lfx",
"100base-tx",
"100base-t1",
"1000base-t",
"1000base-sx",
"1000base-lx",
"1000base-tx",
"2.5gbase-t",
"5gbase-t",
"10gbase-t",
"10gbase-cx4",
"100base-x-sfp",
"1000base-x-gbic",
"1000base-x-sfp",
"10gbase-x-sfpp",
"10gbase-x-xfp",
"10gbase-x-xenpak",
"10gbase-x-x2",
"25gbase-x-sfp28",
"50gbase-x-sfp56",
"40gbase-x-qsfpp",
"50gbase-x-sfp28",
"100gbase-x-cfp",
"100gbase-x-cfp2",
"200gbase-x-cfp2",
"400gbase-x-cfp2",
"100gbase-x-cfp4",
"100gbase-x-cxp",
"100gbase-x-cpak",
"100gbase-x-dsfp",
"100gbase-x-sfpdd",
"100gbase-x-qsfp28",
"100gbase-x-qsfpdd",
"200gbase-x-qsfp56",
"200gbase-x-qsfpdd",
"400gbase-x-qsfp112",
"400gbase-x-qsfpdd",
"400gbase-x-osfp",
"400gbase-x-osfp-rhs",
"400gbase-x-cdfp",
"400gbase-x-cfp8",
"800gbase-x-qsfpdd",
"800gbase-x-osfp",
"1000base-kx",
"2.5gbase-kx",
"5gbase-kr",
"10gbase-kr",
"10gbase-kx4",
"25gbase-kr",
"40gbase-kr4",
"50gbase-kr",
"100gbase-kp4",
"100gbase-kr2",
"100gbase-kr4",
"ieee802.11a",
"ieee802.11g",
"ieee802.11n",
"ieee802.11ac",
"ieee802.11ad",
"ieee802.11ax",
"ieee802.11ay",
"ieee802.11be",
"ieee802.15.1",
"ieee802.15.4",
"other-wireless",
"gsm",
"cdma",
"lte",
"4g",
"5g",
"sonet-oc3",
"sonet-oc12",
"sonet-oc48",
"sonet-oc192",
"sonet-oc768",
"sonet-oc1920",
"sonet-oc3840",
"1gfc-sfp",
"2gfc-sfp",
"4gfc-sfp",
"8gfc-sfpp",
"16gfc-sfpp",
"32gfc-sfp28",
"32gfc-sfpp",
"64gfc-qsfpp",
"64gfc-sfpdd",
"64gfc-sfpp",
"128gfc-qsfp28",
"infiniband-sdr",
"infiniband-ddr",
"infiniband-qdr",
"infiniband-fdr10",
"infiniband-fdr",
"infiniband-edr",
"infiniband-hdr",
"infiniband-ndr",
"infiniband-xdr",
"t1",
"e1",
"t3",
"e3",
"xdsl",
"docsis",
"moca",
"bpon",
"epon",
"10g-epon",
"gpon",
"xg-pon",
"xgs-pon",
"ng-pon2",
"25g-pon",
"50g-pon",
"cisco-stackwise",
"cisco-stackwise-plus",
"cisco-flexstack",
"cisco-flexstack-plus",
"cisco-stackwise-80",
"cisco-stackwise-160",
"cisco-stackwise-320",
"cisco-stackwise-480",
"cisco-stackwise-1t",
"juniper-vcp",
"extreme-summitstack",
"extreme-summitstack-128",
"extreme-summitstack-256",
"extreme-summitstack-512",
"other"
],
"type": "string",
"description": "* `virtual` - Virtual\n* `bridge` - Bridge\n* `lag` - Link Aggregation Group (LAG)\n* `100base-fx` - 100BASE-FX (10/100ME FIBER)\n* `100base-lfx` - 100BASE-LFX (10/100ME FIBER)\n* `100base-tx` - 100BASE-TX (10/100ME)\n* `100base-t1` - 100BASE-T1 (10/100ME Single Pair)\n* `1000base-t` - 1000BASE-T (1GE)\n* `1000base-sx` - 1000BASE-SX (1GE)\n* `1000base-lx` - 1000BASE-LX (1GE)\n* `1000base-tx` - 1000BASE-TX (1GE)\n* `2.5gbase-t` - 2.5GBASE-T (2.5GE)\n* `5gbase-t` - 5GBASE-T (5GE)\n* `10gbase-t` - 10GBASE-T (10GE)\n* `10gbase-cx4` - 10GBASE-CX4 (10GE)\n* `100base-x-sfp` - SFP (100ME)\n* `1000base-x-gbic` - GBIC (1GE)\n* `1000base-x-sfp` - SFP (1GE)\n* `10gbase-x-sfpp` - SFP+ (10GE)\n* `10gbase-x-xfp` - XFP (10GE)\n* `10gbase-x-xenpak` - XENPAK (10GE)\n* `10gbase-x-x2` - X2 (10GE)\n* `25gbase-x-sfp28` - SFP28 (25GE)\n* `50gbase-x-sfp56` - SFP56 (50GE)\n* `40gbase-x-qsfpp` - QSFP+ (40GE)\n* `50gbase-x-sfp28` - QSFP28 (50GE)\n* `100gbase-x-cfp` - CFP (100GE)\n* `100gbase-x-cfp2` - CFP2 (100GE)\n* `200gbase-x-cfp2` - CFP2 (200GE)\n* `400gbase-x-cfp2` - CFP2 (400GE)\n* `100gbase-x-cfp4` - CFP4 (100GE)\n* `100gbase-x-cxp` - CXP (100GE)\n* `100gbase-x-cpak` - Cisco CPAK (100GE)\n* `100gbase-x-dsfp` - DSFP (100GE)\n* `100gbase-x-sfpdd` - SFP-DD (100GE)\n* `100gbase-x-qsfp28` - QSFP28 (100GE)\n* `100gbase-x-qsfpdd` - QSFP-DD (100GE)\n* `200gbase-x-qsfp56` - QSFP56 (200GE)\n* `200gbase-x-qsfpdd` - QSFP-DD (200GE)\n* `400gbase-x-qsfp112` - QSFP112 (400GE)\n* `400gbase-x-qsfpdd` - QSFP-DD (400GE)\n* `400gbase-x-osfp` - OSFP (400GE)\n* `400gbase-x-osfp-rhs` - OSFP-RHS (400GE)\n* `400gbase-x-cdfp` - CDFP (400GE)\n* `400gbase-x-cfp8` - CPF8 (400GE)\n* `800gbase-x-qsfpdd` - QSFP-DD (800GE)\n* `800gbase-x-osfp` - OSFP (800GE)\n* `1000base-kx` - 1000BASE-KX (1GE)\n* `2.5gbase-kx` - 2.5GBASE-KX (2.5GE)\n* `5gbase-kr` - 5GBASE-KR (5GE)\n* `10gbase-kr` - 10GBASE-KR (10GE)\n* `10gbase-kx4` - 10GBASE-KX4 (10GE)\n* `25gbase-kr` - 25GBASE-KR (25GE)\n* `40gbase-kr4` - 40GBASE-KR4 (40GE)\n* `50gbase-kr` - 50GBASE-KR (50GE)\n* `100gbase-kp4` - 100GBASE-KP4 (100GE)\n* `100gbase-kr2` - 100GBASE-KR2 (100GE)\n* `100gbase-kr4` - 100GBASE-KR4 (100GE)\n* `ieee802.11a` - IEEE 802.11a\n* `ieee802.11g` - IEEE 802.11b/g\n* `ieee802.11n` - IEEE 802.11n\n* `ieee802.11ac` - IEEE 802.11ac\n* `ieee802.11ad` - IEEE 802.11ad\n* `ieee802.11ax` - IEEE 802.11ax\n* `ieee802.11ay` - IEEE 802.11ay\n* `ieee802.11be` - IEEE 802.11be\n* `ieee802.15.1` - IEEE 802.15.1 (Bluetooth)\n* `ieee802.15.4` - IEEE 802.15.4 (LR-WPAN)\n* `other-wireless` - Other (Wireless)\n* `gsm` - GSM\n* `cdma` - CDMA\n* `lte` - LTE\n* `4g` - 4G\n* `5g` - 5G\n* `sonet-oc3` - OC-3/STM-1\n* `sonet-oc12` - OC-12/STM-4\n* `sonet-oc48` - OC-48/STM-16\n* `sonet-oc192` - OC-192/STM-64\n* `sonet-oc768` - OC-768/STM-256\n* `sonet-oc1920` - OC-1920/STM-640\n* `sonet-oc3840` - OC-3840/STM-1234\n* `1gfc-sfp` - SFP (1GFC)\n* `2gfc-sfp` - SFP (2GFC)\n* `4gfc-sfp` - SFP (4GFC)\n* `8gfc-sfpp` - SFP+ (8GFC)\n* `16gfc-sfpp` - SFP+ (16GFC)\n* `32gfc-sfp28` - SFP28 (32GFC)\n* `32gfc-sfpp` - SFP+ (32GFC)\n* `64gfc-qsfpp` - QSFP+ (64GFC)\n* `64gfc-sfpdd` - SFP-DD (64GFC)\n* `64gfc-sfpp` - SFP+ (64GFC)\n* `128gfc-qsfp28` - QSFP28 (128GFC)\n* `infiniband-sdr` - SDR (2 Gbps)\n* `infiniband-ddr` - DDR (4 Gbps)\n* `infiniband-qdr` - QDR (8 Gbps)\n* `infiniband-fdr10` - FDR10 (10 Gbps)\n* `infiniband-fdr` - FDR (13.5 Gbps)\n* `infiniband-edr` - EDR (25 Gbps)\n* `infiniband-hdr` - HDR (50 Gbps)\n* `infiniband-ndr` - NDR (100 Gbps)\n* `infiniband-xdr` - XDR (250 Gbps)\n* `t1` - T1 (1.544 Mbps)\n* `e1` - E1 (2.048 Mbps)\n* `t3` - T3 (45 Mbps)\n* `e3` - E3 (34 Mbps)\n* `xdsl` - xDSL\n* `docsis` - DOCSIS\n* `moca` - MoCA\n* `bpon` - BPON (622 Mbps / 155 Mbps)\n* `epon` - EPON (1 Gbps)\n* `10g-epon` - 10G-EPON (10 Gbps)\n* `gpon` - GPON (2.5 Gbps / 1.25 Gbps)\n* `xg-pon` - XG-PON (10 Gbps / 2.5 Gbps)\n* `xgs-pon` - XGS-PON (10 Gbps)\n* `ng-pon2` - NG-PON2 (TWDM-PON) (4x10 Gbps)\n* `25g-pon` - 25G-PON (25 Gbps)\n* `50g-pon` - 50G-PON (50 Gbps)\n* `cisco-stackwise` - Cisco StackWise\n* `cisco-stackwise-plus` - Cisco StackWise Plus\n* `cisco-flexstack` - Cisco FlexStack\n* `cisco-flexstack-plus` - Cisco FlexStack Plus\n* `cisco-stackwise-80` - Cisco StackWise-80\n* `cisco-stackwise-160` - Cisco StackWise-160\n* `cisco-stackwise-320` - Cisco StackWise-320\n* `cisco-stackwise-480` - Cisco StackWise-480\n* `cisco-stackwise-1t` - Cisco StackWise-1T\n* `juniper-vcp` - Juniper VCP\n* `extreme-summitstack` - Extreme SummitStack\n* `extreme-summitstack-128` - Extreme SummitStack-128\n* `extreme-summitstack-256` - Extreme SummitStack-256\n* `extreme-summitstack-512` - Extreme SummitStack-512\n* `other` - Other",
"x-spec-enum-id": "8c4c5e112f77a383"
},
"enabled": {
"type": "boolean"
},
"mgmt_only": {
"type": "boolean",
"title": "Management only"
},
"description": {
"type": "string",
"maxLength": 200
},
"bridge": {
"type": "integer",
"nullable": true,
"title": "Bridge interface"
},
"poe_mode": {
"enum": [
"pd",
"pse",
"",
null
],
"type": "string",
"description": "* `pd` - PD\n* `pse` - PSE",
"x-spec-enum-id": "2f2fe6dcdc7772bd",
"nullable": true
},
"poe_type": {
"enum": [
"type1-ieee802.3af",
"type2-ieee802.3at",
"type3-ieee802.3bt",
"type4-ieee802.3bt",
"passive-24v-2pair",
"passive-24v-4pair",
"passive-48v-2pair",
"passive-48v-4pair",
"",
null
],
"type": "string",
"description": "* `type1-ieee802.3af` - 802.3af (Type 1)\n* `type2-ieee802.3at` - 802.3at (Type 2)\n* `type3-ieee802.3bt` - 802.3bt (Type 3)\n* `type4-ieee802.3bt` - 802.3bt (Type 4)\n* `passive-24v-2pair` - Passive 24V (2-pair)\n* `passive-24v-4pair` - Passive 24V (4-pair)\n* `passive-48v-2pair` - Passive 48V (2-pair)\n* `passive-48v-4pair` - Passive 48V (4-pair)",
"x-spec-enum-id": "74bd3be4012f6da9",
"nullable": true
},
"rf_role": {
"enum": [
"ap",
"station",
"",
null
],
"type": "string",
"description": "* `ap` - Access point\n* `station` - Station",
"x-spec-enum-id": "d2772dbea88b0fb1",
"nullable": true,
"title": "Wireless role"
}
},
"required": [
"name",
"type"
]
},
"WritableInventoryItemRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"device": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDeviceRequest"
}
]
},
"parent": {
"type": "integer",
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"status": {
"enum": [
"offline",
"active",
"planned",
"staged",
"failed",
"decommissioning"
],
"type": "string",
"description": "* `offline` - Offline\n* `active` - Active\n* `planned` - Planned\n* `staged` - Staged\n* `failed` - Failed\n* `decommissioning` - Decommissioning",
"x-spec-enum-id": "2217e87d0c3efdda"
},
"role": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefInventoryItemRoleRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"manufacturer": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefManufacturerRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"part_id": {
"type": "string",
"description": "Manufacturer-assigned part identifier",
"maxLength": 50
},
"serial": {
"type": "string",
"title": "Serial number",
"maxLength": 50
},
"asset_tag": {
"type": "string",
"nullable": true,
"description": "A unique tag used to identify this item",
"maxLength": 50
},
"discovered": {
"type": "boolean",
"description": "This item was automatically discovered"
},
"description": {
"type": "string",
"maxLength": 200
},
"component_type": {
"type": "string",
"nullable": true
},
"component_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64",
"nullable": true
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"device",
"name"
]
},
"WritableJournalEntryRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"assigned_object_type": {
"type": "string"
},
"assigned_object_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64"
},
"created_by": {
"type": "integer",
"nullable": true
},
"kind": {
"enum": [
"info",
"success",
"warning",
"danger"
],
"type": "string",
"description": "* `info` - Info\n* `success` - Success\n* `warning` - Warning\n* `danger` - Danger",
"x-spec-enum-id": "a21af280f632fa34"
},
"comments": {
"type": "string",
"minLength": 1
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"assigned_object_id",
"assigned_object_type",
"comments"
]
},
"WritableL2VPNRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"identifier": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"format": "int64",
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"type": {
"enum": [
"vpws",
"vpls",
"vxlan",
"vxlan-evpn",
"mpls-evpn",
"pbb-evpn",
"evpn-vpws",
"epl",
"evpl",
"ep-lan",
"evp-lan",
"ep-tree",
"evp-tree",
"spb"
],
"type": "string",
"description": "* `vpws` - VPWS\n* `vpls` - VPLS\n* `vxlan` - VXLAN\n* `vxlan-evpn` - VXLAN-EVPN\n* `mpls-evpn` - MPLS EVPN\n* `pbb-evpn` - PBB EVPN\n* `evpn-vpws` - EVPN VPWS\n* `epl` - EPL\n* `evpl` - EVPL\n* `ep-lan` - Ethernet Private LAN\n* `evp-lan` - Ethernet Virtual Private LAN\n* `ep-tree` - Ethernet Private Tree\n* `evp-tree` - Ethernet Virtual Private Tree\n* `spb` - SPB",
"x-spec-enum-id": "730136816a2885f9"
},
"status": {
"enum": [
"active",
"planned",
"decommissioning"
],
"type": "string",
"description": "* `active` - Active\n* `planned` - Planned\n* `decommissioning` - Decommissioning",
"x-spec-enum-id": "937bacafb9d5d4bb"
},
"import_targets": {
"type": "array",
"items": {
"type": "integer"
}
},
"export_targets": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name",
"slug",
"type"
]
},
"WritableLocationRequest": {
"type": "object",
"description": "Extends PrimaryModelSerializer to include MPTT support.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"site": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefSiteRequest"
}
]
},
"parent": {
"type": "integer",
"nullable": true
},
"status": {
"enum": [
"planned",
"staging",
"active",
"decommissioning",
"retired"
],
"type": "string",
"description": "* `planned` - Planned\n* `staging` - Staging\n* `active` - Active\n* `decommissioning` - Decommissioning\n* `retired` - Retired",
"x-spec-enum-id": "e363a8ddb138be50"
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"facility": {
"type": "string",
"description": "Local facility ID or description",
"maxLength": 50
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"comments": {
"type": "string"
}
},
"required": [
"name",
"site",
"slug"
]
},
"WritableModuleRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"device": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDeviceRequest"
}
]
},
"module_bay": {
"type": "integer"
},
"module_type": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefModuleTypeRequest"
}
]
},
"status": {
"enum": [
"offline",
"active",
"planned",
"staged",
"failed",
"decommissioning"
],
"type": "string",
"description": "* `offline` - Offline\n* `active` - Active\n* `planned` - Planned\n* `staged` - Staged\n* `failed` - Failed\n* `decommissioning` - Decommissioning",
"x-spec-enum-id": "2217e87d0c3efdda"
},
"serial": {
"type": "string",
"title": "Serial number",
"maxLength": 50
},
"asset_tag": {
"type": "string",
"nullable": true,
"description": "A unique tag used to identify this device",
"maxLength": 50
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"device",
"module_bay",
"module_type"
]
},
"WritableModuleTypeRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"profile": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleTypeProfileRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"manufacturer": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefManufacturerRequest"
}
]
},
"model": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"part_number": {
"type": "string",
"description": "Discrete part number (optional)",
"maxLength": 50
},
"airflow": {
"enum": [
"front-to-rear",
"rear-to-front",
"left-to-right",
"right-to-left",
"side-to-rear",
"passive",
"",
null
],
"type": "string",
"description": "* `front-to-rear` - Front to rear\n* `rear-to-front` - Rear to front\n* `left-to-right` - Left to right\n* `right-to-left` - Right to left\n* `side-to-rear` - Side to rear\n* `passive` - Passive",
"x-spec-enum-id": "f6e5562e0e98d69d",
"nullable": true
},
"weight": {
"type": "number",
"format": "double",
"maximum": 1000000,
"minimum": -1000000,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true
},
"weight_unit": {
"enum": [
"kg",
"g",
"lb",
"oz",
"",
null
],
"type": "string",
"description": "* `kg` - Kilograms\n* `g` - Grams\n* `lb` - Pounds\n* `oz` - Ounces",
"x-spec-enum-id": "7c1876f422815884",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"attributes": {
"nullable": true
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"manufacturer",
"model"
]
},
"WritablePlatformRequest": {
"type": "object",
"description": "Extends PrimaryModelSerializer to include MPTT support.",
"properties": {
"parent": {
"type": "integer",
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"manufacturer": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefManufacturerRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"config_template": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefConfigTemplateRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name",
"slug"
]
},
"WritablePowerFeedRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"power_panel": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefPowerPanelRequest"
}
]
},
"rack": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefRackRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"status": {
"enum": [
"offline",
"active",
"planned",
"failed"
],
"type": "string",
"description": "* `offline` - Offline\n* `active` - Active\n* `planned` - Planned\n* `failed` - Failed",
"x-spec-enum-id": "b77fc919138c12f6"
},
"type": {
"enum": [
"primary",
"redundant"
],
"type": "string",
"description": "* `primary` - Primary\n* `redundant` - Redundant",
"x-spec-enum-id": "093a164236819eb8"
},
"supply": {
"enum": [
"ac",
"dc"
],
"type": "string",
"description": "* `ac` - AC\n* `dc` - DC",
"x-spec-enum-id": "1b6d99616ca6412b"
},
"phase": {
"enum": [
"single-phase",
"three-phase"
],
"type": "string",
"description": "* `single-phase` - Single phase\n* `three-phase` - Three-phase",
"x-spec-enum-id": "994bc0696f4df57f"
},
"voltage": {
"type": "integer",
"maximum": 32767,
"minimum": -32768
},
"amperage": {
"type": "integer",
"maximum": 32767,
"minimum": 1
},
"max_utilization": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Maximum permissible draw (percentage)"
},
"mark_connected": {
"type": "boolean",
"description": "Treat as if a cable is connected"
},
"description": {
"type": "string",
"maxLength": 200
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name",
"power_panel"
]
},
"WritablePowerOutletRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"device": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDeviceRequest"
}
]
},
"module": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"enum": [
"iec-60320-c5",
"iec-60320-c7",
"iec-60320-c13",
"iec-60320-c15",
"iec-60320-c17",
"iec-60320-c19",
"iec-60320-c21",
"iec-60309-p-n-e-4h",
"iec-60309-p-n-e-6h",
"iec-60309-p-n-e-9h",
"iec-60309-2p-e-4h",
"iec-60309-2p-e-6h",
"iec-60309-2p-e-9h",
"iec-60309-3p-e-4h",
"iec-60309-3p-e-6h",
"iec-60309-3p-e-9h",
"iec-60309-3p-n-e-4h",
"iec-60309-3p-n-e-6h",
"iec-60309-3p-n-e-9h",
"iec-60906-1",
"nbr-14136-10a",
"nbr-14136-20a",
"nema-1-15r",
"nema-5-15r",
"nema-5-20r",
"nema-5-30r",
"nema-5-50r",
"nema-6-15r",
"nema-6-20r",
"nema-6-30r",
"nema-6-50r",
"nema-10-30r",
"nema-10-50r",
"nema-14-20r",
"nema-14-30r",
"nema-14-50r",
"nema-14-60r",
"nema-15-15r",
"nema-15-20r",
"nema-15-30r",
"nema-15-50r",
"nema-15-60r",
"nema-l1-15r",
"nema-l5-15r",
"nema-l5-20r",
"nema-l5-30r",
"nema-l5-50r",
"nema-l6-15r",
"nema-l6-20r",
"nema-l6-30r",
"nema-l6-50r",
"nema-l10-30r",
"nema-l14-20r",
"nema-l14-30r",
"nema-l14-50r",
"nema-l14-60r",
"nema-l15-20r",
"nema-l15-30r",
"nema-l15-50r",
"nema-l15-60r",
"nema-l21-20r",
"nema-l21-30r",
"nema-l22-20r",
"nema-l22-30r",
"CS6360C",
"CS6364C",
"CS8164C",
"CS8264C",
"CS8364C",
"CS8464C",
"ita-e",
"ita-f",
"ita-g",
"ita-h",
"ita-i",
"ita-j",
"ita-k",
"ita-l",
"ita-m",
"ita-n",
"ita-o",
"ita-multistandard",
"usb-a",
"usb-micro-b",
"usb-c",
"molex-micro-fit-1x2",
"molex-micro-fit-2x2",
"molex-micro-fit-2x4",
"dc-terminal",
"eaton-c39",
"hdot-cx",
"saf-d-grid",
"neutrik-powercon-20a",
"neutrik-powercon-32a",
"neutrik-powercon-true1",
"neutrik-powercon-true1-top",
"ubiquiti-smartpower",
"hardwired",
"other",
"",
null
],
"type": "string",
"x-spec-enum-id": "8f9617d2648ab261",
"nullable": true,
"description": "Physical port type\n\n* `iec-60320-c5` - C5\n* `iec-60320-c7` - C7\n* `iec-60320-c13` - C13\n* `iec-60320-c15` - C15\n* `iec-60320-c17` - C17\n* `iec-60320-c19` - C19\n* `iec-60320-c21` - C21\n* `iec-60309-p-n-e-4h` - P+N+E 4H\n* `iec-60309-p-n-e-6h` - P+N+E 6H\n* `iec-60309-p-n-e-9h` - P+N+E 9H\n* `iec-60309-2p-e-4h` - 2P+E 4H\n* `iec-60309-2p-e-6h` - 2P+E 6H\n* `iec-60309-2p-e-9h` - 2P+E 9H\n* `iec-60309-3p-e-4h` - 3P+E 4H\n* `iec-60309-3p-e-6h` - 3P+E 6H\n* `iec-60309-3p-e-9h` - 3P+E 9H\n* `iec-60309-3p-n-e-4h` - 3P+N+E 4H\n* `iec-60309-3p-n-e-6h` - 3P+N+E 6H\n* `iec-60309-3p-n-e-9h` - 3P+N+E 9H\n* `iec-60906-1` - IEC 60906-1\n* `nbr-14136-10a` - 2P+T 10A (NBR 14136)\n* `nbr-14136-20a` - 2P+T 20A (NBR 14136)\n* `nema-1-15r` - NEMA 1-15R\n* `nema-5-15r` - NEMA 5-15R\n* `nema-5-20r` - NEMA 5-20R\n* `nema-5-30r` - NEMA 5-30R\n* `nema-5-50r` - NEMA 5-50R\n* `nema-6-15r` - NEMA 6-15R\n* `nema-6-20r` - NEMA 6-20R\n* `nema-6-30r` - NEMA 6-30R\n* `nema-6-50r` - NEMA 6-50R\n* `nema-10-30r` - NEMA 10-30R\n* `nema-10-50r` - NEMA 10-50R\n* `nema-14-20r` - NEMA 14-20R\n* `nema-14-30r` - NEMA 14-30R\n* `nema-14-50r` - NEMA 14-50R\n* `nema-14-60r` - NEMA 14-60R\n* `nema-15-15r` - NEMA 15-15R\n* `nema-15-20r` - NEMA 15-20R\n* `nema-15-30r` - NEMA 15-30R\n* `nema-15-50r` - NEMA 15-50R\n* `nema-15-60r` - NEMA 15-60R\n* `nema-l1-15r` - NEMA L1-15R\n* `nema-l5-15r` - NEMA L5-15R\n* `nema-l5-20r` - NEMA L5-20R\n* `nema-l5-30r` - NEMA L5-30R\n* `nema-l5-50r` - NEMA L5-50R\n* `nema-l6-15r` - NEMA L6-15R\n* `nema-l6-20r` - NEMA L6-20R\n* `nema-l6-30r` - NEMA L6-30R\n* `nema-l6-50r` - NEMA L6-50R\n* `nema-l10-30r` - NEMA L10-30R\n* `nema-l14-20r` - NEMA L14-20R\n* `nema-l14-30r` - NEMA L14-30R\n* `nema-l14-50r` - NEMA L14-50R\n* `nema-l14-60r` - NEMA L14-60R\n* `nema-l15-20r` - NEMA L15-20R\n* `nema-l15-30r` - NEMA L15-30R\n* `nema-l15-50r` - NEMA L15-50R\n* `nema-l15-60r` - NEMA L15-60R\n* `nema-l21-20r` - NEMA L21-20R\n* `nema-l21-30r` - NEMA L21-30R\n* `nema-l22-20r` - NEMA L22-20R\n* `nema-l22-30r` - NEMA L22-30R\n* `CS6360C` - CS6360C\n* `CS6364C` - CS6364C\n* `CS8164C` - CS8164C\n* `CS8264C` - CS8264C\n* `CS8364C` - CS8364C\n* `CS8464C` - CS8464C\n* `ita-e` - ITA Type E (CEE 7/5)\n* `ita-f` - ITA Type F (CEE 7/3)\n* `ita-g` - ITA Type G (BS 1363)\n* `ita-h` - ITA Type H\n* `ita-i` - ITA Type I\n* `ita-j` - ITA Type J\n* `ita-k` - ITA Type K\n* `ita-l` - ITA Type L (CEI 23-50)\n* `ita-m` - ITA Type M (BS 546)\n* `ita-n` - ITA Type N\n* `ita-o` - ITA Type O\n* `ita-multistandard` - ITA Multistandard\n* `usb-a` - USB Type A\n* `usb-micro-b` - USB Micro B\n* `usb-c` - USB Type C\n* `molex-micro-fit-1x2` - Molex Micro-Fit 1x2\n* `molex-micro-fit-2x2` - Molex Micro-Fit 2x2\n* `molex-micro-fit-2x4` - Molex Micro-Fit 2x4\n* `dc-terminal` - DC Terminal\n* `eaton-c39` - Eaton C39\n* `hdot-cx` - HDOT Cx\n* `saf-d-grid` - Saf-D-Grid\n* `neutrik-powercon-20a` - Neutrik powerCON (20A)\n* `neutrik-powercon-32a` - Neutrik powerCON (32A)\n* `neutrik-powercon-true1` - Neutrik powerCON TRUE1\n* `neutrik-powercon-true1-top` - Neutrik powerCON TRUE1 TOP\n* `ubiquiti-smartpower` - Ubiquiti SmartPower\n* `hardwired` - Hardwired\n* `other` - Other"
},
"status": {
"enum": [
"enabled",
"disabled",
"faulty"
],
"type": "string",
"description": "* `enabled` - Enabled\n* `disabled` - Disabled\n* `faulty` - Faulty",
"x-spec-enum-id": "1024f7deaed962d7"
},
"color": {
"type": "string",
"pattern": "^[0-9a-f]{6}$",
"maxLength": 6
},
"power_port": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefPowerPortRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"feed_leg": {
"enum": [
"A",
"B",
"C",
"",
null
],
"type": "string",
"x-spec-enum-id": "a4902339df0b7c06",
"nullable": true,
"description": "Phase (for three-phase feeds)\n\n* `A` - A\n* `B` - B\n* `C` - C"
},
"description": {
"type": "string",
"maxLength": 200
},
"mark_connected": {
"type": "boolean",
"description": "Treat as if a cable is connected"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"device",
"name"
]
},
"WritablePowerOutletTemplateRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"device_type": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefDeviceTypeRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"module_type": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleTypeRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"description": "{module} is accepted as a substitution for the module bay position when attached to a module type.",
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"enum": [
"iec-60320-c5",
"iec-60320-c7",
"iec-60320-c13",
"iec-60320-c15",
"iec-60320-c17",
"iec-60320-c19",
"iec-60320-c21",
"iec-60309-p-n-e-4h",
"iec-60309-p-n-e-6h",
"iec-60309-p-n-e-9h",
"iec-60309-2p-e-4h",
"iec-60309-2p-e-6h",
"iec-60309-2p-e-9h",
"iec-60309-3p-e-4h",
"iec-60309-3p-e-6h",
"iec-60309-3p-e-9h",
"iec-60309-3p-n-e-4h",
"iec-60309-3p-n-e-6h",
"iec-60309-3p-n-e-9h",
"iec-60906-1",
"nbr-14136-10a",
"nbr-14136-20a",
"nema-1-15r",
"nema-5-15r",
"nema-5-20r",
"nema-5-30r",
"nema-5-50r",
"nema-6-15r",
"nema-6-20r",
"nema-6-30r",
"nema-6-50r",
"nema-10-30r",
"nema-10-50r",
"nema-14-20r",
"nema-14-30r",
"nema-14-50r",
"nema-14-60r",
"nema-15-15r",
"nema-15-20r",
"nema-15-30r",
"nema-15-50r",
"nema-15-60r",
"nema-l1-15r",
"nema-l5-15r",
"nema-l5-20r",
"nema-l5-30r",
"nema-l5-50r",
"nema-l6-15r",
"nema-l6-20r",
"nema-l6-30r",
"nema-l6-50r",
"nema-l10-30r",
"nema-l14-20r",
"nema-l14-30r",
"nema-l14-50r",
"nema-l14-60r",
"nema-l15-20r",
"nema-l15-30r",
"nema-l15-50r",
"nema-l15-60r",
"nema-l21-20r",
"nema-l21-30r",
"nema-l22-20r",
"nema-l22-30r",
"CS6360C",
"CS6364C",
"CS8164C",
"CS8264C",
"CS8364C",
"CS8464C",
"ita-e",
"ita-f",
"ita-g",
"ita-h",
"ita-i",
"ita-j",
"ita-k",
"ita-l",
"ita-m",
"ita-n",
"ita-o",
"ita-multistandard",
"usb-a",
"usb-micro-b",
"usb-c",
"molex-micro-fit-1x2",
"molex-micro-fit-2x2",
"molex-micro-fit-2x4",
"dc-terminal",
"eaton-c39",
"hdot-cx",
"saf-d-grid",
"neutrik-powercon-20a",
"neutrik-powercon-32a",
"neutrik-powercon-true1",
"neutrik-powercon-true1-top",
"ubiquiti-smartpower",
"hardwired",
"other",
"",
null
],
"type": "string",
"description": "* `iec-60320-c5` - C5\n* `iec-60320-c7` - C7\n* `iec-60320-c13` - C13\n* `iec-60320-c15` - C15\n* `iec-60320-c17` - C17\n* `iec-60320-c19` - C19\n* `iec-60320-c21` - C21\n* `iec-60309-p-n-e-4h` - P+N+E 4H\n* `iec-60309-p-n-e-6h` - P+N+E 6H\n* `iec-60309-p-n-e-9h` - P+N+E 9H\n* `iec-60309-2p-e-4h` - 2P+E 4H\n* `iec-60309-2p-e-6h` - 2P+E 6H\n* `iec-60309-2p-e-9h` - 2P+E 9H\n* `iec-60309-3p-e-4h` - 3P+E 4H\n* `iec-60309-3p-e-6h` - 3P+E 6H\n* `iec-60309-3p-e-9h` - 3P+E 9H\n* `iec-60309-3p-n-e-4h` - 3P+N+E 4H\n* `iec-60309-3p-n-e-6h` - 3P+N+E 6H\n* `iec-60309-3p-n-e-9h` - 3P+N+E 9H\n* `iec-60906-1` - IEC 60906-1\n* `nbr-14136-10a` - 2P+T 10A (NBR 14136)\n* `nbr-14136-20a` - 2P+T 20A (NBR 14136)\n* `nema-1-15r` - NEMA 1-15R\n* `nema-5-15r` - NEMA 5-15R\n* `nema-5-20r` - NEMA 5-20R\n* `nema-5-30r` - NEMA 5-30R\n* `nema-5-50r` - NEMA 5-50R\n* `nema-6-15r` - NEMA 6-15R\n* `nema-6-20r` - NEMA 6-20R\n* `nema-6-30r` - NEMA 6-30R\n* `nema-6-50r` - NEMA 6-50R\n* `nema-10-30r` - NEMA 10-30R\n* `nema-10-50r` - NEMA 10-50R\n* `nema-14-20r` - NEMA 14-20R\n* `nema-14-30r` - NEMA 14-30R\n* `nema-14-50r` - NEMA 14-50R\n* `nema-14-60r` - NEMA 14-60R\n* `nema-15-15r` - NEMA 15-15R\n* `nema-15-20r` - NEMA 15-20R\n* `nema-15-30r` - NEMA 15-30R\n* `nema-15-50r` - NEMA 15-50R\n* `nema-15-60r` - NEMA 15-60R\n* `nema-l1-15r` - NEMA L1-15R\n* `nema-l5-15r` - NEMA L5-15R\n* `nema-l5-20r` - NEMA L5-20R\n* `nema-l5-30r` - NEMA L5-30R\n* `nema-l5-50r` - NEMA L5-50R\n* `nema-l6-15r` - NEMA L6-15R\n* `nema-l6-20r` - NEMA L6-20R\n* `nema-l6-30r` - NEMA L6-30R\n* `nema-l6-50r` - NEMA L6-50R\n* `nema-l10-30r` - NEMA L10-30R\n* `nema-l14-20r` - NEMA L14-20R\n* `nema-l14-30r` - NEMA L14-30R\n* `nema-l14-50r` - NEMA L14-50R\n* `nema-l14-60r` - NEMA L14-60R\n* `nema-l15-20r` - NEMA L15-20R\n* `nema-l15-30r` - NEMA L15-30R\n* `nema-l15-50r` - NEMA L15-50R\n* `nema-l15-60r` - NEMA L15-60R\n* `nema-l21-20r` - NEMA L21-20R\n* `nema-l21-30r` - NEMA L21-30R\n* `nema-l22-20r` - NEMA L22-20R\n* `nema-l22-30r` - NEMA L22-30R\n* `CS6360C` - CS6360C\n* `CS6364C` - CS6364C\n* `CS8164C` - CS8164C\n* `CS8264C` - CS8264C\n* `CS8364C` - CS8364C\n* `CS8464C` - CS8464C\n* `ita-e` - ITA Type E (CEE 7/5)\n* `ita-f` - ITA Type F (CEE 7/3)\n* `ita-g` - ITA Type G (BS 1363)\n* `ita-h` - ITA Type H\n* `ita-i` - ITA Type I\n* `ita-j` - ITA Type J\n* `ita-k` - ITA Type K\n* `ita-l` - ITA Type L (CEI 23-50)\n* `ita-m` - ITA Type M (BS 546)\n* `ita-n` - ITA Type N\n* `ita-o` - ITA Type O\n* `ita-multistandard` - ITA Multistandard\n* `usb-a` - USB Type A\n* `usb-micro-b` - USB Micro B\n* `usb-c` - USB Type C\n* `molex-micro-fit-1x2` - Molex Micro-Fit 1x2\n* `molex-micro-fit-2x2` - Molex Micro-Fit 2x2\n* `molex-micro-fit-2x4` - Molex Micro-Fit 2x4\n* `dc-terminal` - DC Terminal\n* `eaton-c39` - Eaton C39\n* `hdot-cx` - HDOT Cx\n* `saf-d-grid` - Saf-D-Grid\n* `neutrik-powercon-20a` - Neutrik powerCON (20A)\n* `neutrik-powercon-32a` - Neutrik powerCON (32A)\n* `neutrik-powercon-true1` - Neutrik powerCON TRUE1\n* `neutrik-powercon-true1-top` - Neutrik powerCON TRUE1 TOP\n* `ubiquiti-smartpower` - Ubiquiti SmartPower\n* `hardwired` - Hardwired\n* `other` - Other",
"x-spec-enum-id": "8f9617d2648ab261",
"nullable": true
},
"power_port": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefPowerPortTemplateRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"feed_leg": {
"enum": [
"A",
"B",
"C",
"",
null
],
"type": "string",
"x-spec-enum-id": "a4902339df0b7c06",
"nullable": true,
"description": "Phase (for three-phase feeds)\n\n* `A` - A\n* `B` - B\n* `C` - C"
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name"
]
},
"WritablePowerPortRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"device": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDeviceRequest"
}
]
},
"module": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"enum": [
"iec-60320-c6",
"iec-60320-c8",
"iec-60320-c14",
"iec-60320-c16",
"iec-60320-c18",
"iec-60320-c20",
"iec-60320-c22",
"iec-60309-p-n-e-4h",
"iec-60309-p-n-e-6h",
"iec-60309-p-n-e-9h",
"iec-60309-2p-e-4h",
"iec-60309-2p-e-6h",
"iec-60309-2p-e-9h",
"iec-60309-3p-e-4h",
"iec-60309-3p-e-6h",
"iec-60309-3p-e-9h",
"iec-60309-3p-n-e-4h",
"iec-60309-3p-n-e-6h",
"iec-60309-3p-n-e-9h",
"iec-60906-1",
"nbr-14136-10a",
"nbr-14136-20a",
"nema-1-15p",
"nema-5-15p",
"nema-5-20p",
"nema-5-30p",
"nema-5-50p",
"nema-6-15p",
"nema-6-20p",
"nema-6-30p",
"nema-6-50p",
"nema-10-30p",
"nema-10-50p",
"nema-14-20p",
"nema-14-30p",
"nema-14-50p",
"nema-14-60p",
"nema-15-15p",
"nema-15-20p",
"nema-15-30p",
"nema-15-50p",
"nema-15-60p",
"nema-l1-15p",
"nema-l5-15p",
"nema-l5-20p",
"nema-l5-30p",
"nema-l5-50p",
"nema-l6-15p",
"nema-l6-20p",
"nema-l6-30p",
"nema-l6-50p",
"nema-l10-30p",
"nema-l14-20p",
"nema-l14-30p",
"nema-l14-50p",
"nema-l14-60p",
"nema-l15-20p",
"nema-l15-30p",
"nema-l15-50p",
"nema-l15-60p",
"nema-l21-20p",
"nema-l21-30p",
"nema-l22-20p",
"nema-l22-30p",
"cs6361c",
"cs6365c",
"cs8165c",
"cs8265c",
"cs8365c",
"cs8465c",
"ita-c",
"ita-e",
"ita-f",
"ita-ef",
"ita-g",
"ita-h",
"ita-i",
"ita-j",
"ita-k",
"ita-l",
"ita-m",
"ita-n",
"ita-o",
"usb-a",
"usb-b",
"usb-c",
"usb-mini-a",
"usb-mini-b",
"usb-micro-a",
"usb-micro-b",
"usb-micro-ab",
"usb-3-b",
"usb-3-micro-b",
"molex-micro-fit-1x2",
"molex-micro-fit-2x2",
"molex-micro-fit-2x4",
"dc-terminal",
"saf-d-grid",
"neutrik-powercon-20",
"neutrik-powercon-32",
"neutrik-powercon-true1",
"neutrik-powercon-true1-top",
"ubiquiti-smartpower",
"hardwired",
"other",
"",
null
],
"type": "string",
"x-spec-enum-id": "292850be2c08f7df",
"nullable": true,
"description": "Physical port type\n\n* `iec-60320-c6` - C6\n* `iec-60320-c8` - C8\n* `iec-60320-c14` - C14\n* `iec-60320-c16` - C16\n* `iec-60320-c18` - C18\n* `iec-60320-c20` - C20\n* `iec-60320-c22` - C22\n* `iec-60309-p-n-e-4h` - P+N+E 4H\n* `iec-60309-p-n-e-6h` - P+N+E 6H\n* `iec-60309-p-n-e-9h` - P+N+E 9H\n* `iec-60309-2p-e-4h` - 2P+E 4H\n* `iec-60309-2p-e-6h` - 2P+E 6H\n* `iec-60309-2p-e-9h` - 2P+E 9H\n* `iec-60309-3p-e-4h` - 3P+E 4H\n* `iec-60309-3p-e-6h` - 3P+E 6H\n* `iec-60309-3p-e-9h` - 3P+E 9H\n* `iec-60309-3p-n-e-4h` - 3P+N+E 4H\n* `iec-60309-3p-n-e-6h` - 3P+N+E 6H\n* `iec-60309-3p-n-e-9h` - 3P+N+E 9H\n* `iec-60906-1` - IEC 60906-1\n* `nbr-14136-10a` - 2P+T 10A (NBR 14136)\n* `nbr-14136-20a` - 2P+T 20A (NBR 14136)\n* `nema-1-15p` - NEMA 1-15P\n* `nema-5-15p` - NEMA 5-15P\n* `nema-5-20p` - NEMA 5-20P\n* `nema-5-30p` - NEMA 5-30P\n* `nema-5-50p` - NEMA 5-50P\n* `nema-6-15p` - NEMA 6-15P\n* `nema-6-20p` - NEMA 6-20P\n* `nema-6-30p` - NEMA 6-30P\n* `nema-6-50p` - NEMA 6-50P\n* `nema-10-30p` - NEMA 10-30P\n* `nema-10-50p` - NEMA 10-50P\n* `nema-14-20p` - NEMA 14-20P\n* `nema-14-30p` - NEMA 14-30P\n* `nema-14-50p` - NEMA 14-50P\n* `nema-14-60p` - NEMA 14-60P\n* `nema-15-15p` - NEMA 15-15P\n* `nema-15-20p` - NEMA 15-20P\n* `nema-15-30p` - NEMA 15-30P\n* `nema-15-50p` - NEMA 15-50P\n* `nema-15-60p` - NEMA 15-60P\n* `nema-l1-15p` - NEMA L1-15P\n* `nema-l5-15p` - NEMA L5-15P\n* `nema-l5-20p` - NEMA L5-20P\n* `nema-l5-30p` - NEMA L5-30P\n* `nema-l5-50p` - NEMA L5-50P\n* `nema-l6-15p` - NEMA L6-15P\n* `nema-l6-20p` - NEMA L6-20P\n* `nema-l6-30p` - NEMA L6-30P\n* `nema-l6-50p` - NEMA L6-50P\n* `nema-l10-30p` - NEMA L10-30P\n* `nema-l14-20p` - NEMA L14-20P\n* `nema-l14-30p` - NEMA L14-30P\n* `nema-l14-50p` - NEMA L14-50P\n* `nema-l14-60p` - NEMA L14-60P\n* `nema-l15-20p` - NEMA L15-20P\n* `nema-l15-30p` - NEMA L15-30P\n* `nema-l15-50p` - NEMA L15-50P\n* `nema-l15-60p` - NEMA L15-60P\n* `nema-l21-20p` - NEMA L21-20P\n* `nema-l21-30p` - NEMA L21-30P\n* `nema-l22-20p` - NEMA L22-20P\n* `nema-l22-30p` - NEMA L22-30P\n* `cs6361c` - CS6361C\n* `cs6365c` - CS6365C\n* `cs8165c` - CS8165C\n* `cs8265c` - CS8265C\n* `cs8365c` - CS8365C\n* `cs8465c` - CS8465C\n* `ita-c` - ITA Type C (CEE 7/16)\n* `ita-e` - ITA Type E (CEE 7/6)\n* `ita-f` - ITA Type F (CEE 7/4)\n* `ita-ef` - ITA Type E/F (CEE 7/7)\n* `ita-g` - ITA Type G (BS 1363)\n* `ita-h` - ITA Type H\n* `ita-i` - ITA Type I\n* `ita-j` - ITA Type J\n* `ita-k` - ITA Type K\n* `ita-l` - ITA Type L (CEI 23-50)\n* `ita-m` - ITA Type M (BS 546)\n* `ita-n` - ITA Type N\n* `ita-o` - ITA Type O\n* `usb-a` - USB Type A\n* `usb-b` - USB Type B\n* `usb-c` - USB Type C\n* `usb-mini-a` - USB Mini A\n* `usb-mini-b` - USB Mini B\n* `usb-micro-a` - USB Micro A\n* `usb-micro-b` - USB Micro B\n* `usb-micro-ab` - USB Micro AB\n* `usb-3-b` - USB 3.0 Type B\n* `usb-3-micro-b` - USB 3.0 Micro B\n* `molex-micro-fit-1x2` - Molex Micro-Fit 1x2\n* `molex-micro-fit-2x2` - Molex Micro-Fit 2x2\n* `molex-micro-fit-2x4` - Molex Micro-Fit 2x4\n* `dc-terminal` - DC Terminal\n* `saf-d-grid` - Saf-D-Grid\n* `neutrik-powercon-20` - Neutrik powerCON (20A)\n* `neutrik-powercon-32` - Neutrik powerCON (32A)\n* `neutrik-powercon-true1` - Neutrik powerCON TRUE1\n* `neutrik-powercon-true1-top` - Neutrik powerCON TRUE1 TOP\n* `ubiquiti-smartpower` - Ubiquiti SmartPower\n* `hardwired` - Hardwired\n* `other` - Other"
},
"maximum_draw": {
"type": "integer",
"maximum": 2147483647,
"minimum": 1,
"nullable": true,
"description": "Maximum power draw (watts)"
},
"allocated_draw": {
"type": "integer",
"maximum": 2147483647,
"minimum": 1,
"nullable": true,
"description": "Allocated power draw (watts)"
},
"description": {
"type": "string",
"maxLength": 200
},
"mark_connected": {
"type": "boolean",
"description": "Treat as if a cable is connected"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"device",
"name"
]
},
"WritablePowerPortTemplateRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"device_type": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefDeviceTypeRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"module_type": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleTypeRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"description": "{module} is accepted as a substitution for the module bay position when attached to a module type.",
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"enum": [
"iec-60320-c6",
"iec-60320-c8",
"iec-60320-c14",
"iec-60320-c16",
"iec-60320-c18",
"iec-60320-c20",
"iec-60320-c22",
"iec-60309-p-n-e-4h",
"iec-60309-p-n-e-6h",
"iec-60309-p-n-e-9h",
"iec-60309-2p-e-4h",
"iec-60309-2p-e-6h",
"iec-60309-2p-e-9h",
"iec-60309-3p-e-4h",
"iec-60309-3p-e-6h",
"iec-60309-3p-e-9h",
"iec-60309-3p-n-e-4h",
"iec-60309-3p-n-e-6h",
"iec-60309-3p-n-e-9h",
"iec-60906-1",
"nbr-14136-10a",
"nbr-14136-20a",
"nema-1-15p",
"nema-5-15p",
"nema-5-20p",
"nema-5-30p",
"nema-5-50p",
"nema-6-15p",
"nema-6-20p",
"nema-6-30p",
"nema-6-50p",
"nema-10-30p",
"nema-10-50p",
"nema-14-20p",
"nema-14-30p",
"nema-14-50p",
"nema-14-60p",
"nema-15-15p",
"nema-15-20p",
"nema-15-30p",
"nema-15-50p",
"nema-15-60p",
"nema-l1-15p",
"nema-l5-15p",
"nema-l5-20p",
"nema-l5-30p",
"nema-l5-50p",
"nema-l6-15p",
"nema-l6-20p",
"nema-l6-30p",
"nema-l6-50p",
"nema-l10-30p",
"nema-l14-20p",
"nema-l14-30p",
"nema-l14-50p",
"nema-l14-60p",
"nema-l15-20p",
"nema-l15-30p",
"nema-l15-50p",
"nema-l15-60p",
"nema-l21-20p",
"nema-l21-30p",
"nema-l22-20p",
"nema-l22-30p",
"cs6361c",
"cs6365c",
"cs8165c",
"cs8265c",
"cs8365c",
"cs8465c",
"ita-c",
"ita-e",
"ita-f",
"ita-ef",
"ita-g",
"ita-h",
"ita-i",
"ita-j",
"ita-k",
"ita-l",
"ita-m",
"ita-n",
"ita-o",
"usb-a",
"usb-b",
"usb-c",
"usb-mini-a",
"usb-mini-b",
"usb-micro-a",
"usb-micro-b",
"usb-micro-ab",
"usb-3-b",
"usb-3-micro-b",
"molex-micro-fit-1x2",
"molex-micro-fit-2x2",
"molex-micro-fit-2x4",
"dc-terminal",
"saf-d-grid",
"neutrik-powercon-20",
"neutrik-powercon-32",
"neutrik-powercon-true1",
"neutrik-powercon-true1-top",
"ubiquiti-smartpower",
"hardwired",
"other",
"",
null
],
"type": "string",
"description": "* `iec-60320-c6` - C6\n* `iec-60320-c8` - C8\n* `iec-60320-c14` - C14\n* `iec-60320-c16` - C16\n* `iec-60320-c18` - C18\n* `iec-60320-c20` - C20\n* `iec-60320-c22` - C22\n* `iec-60309-p-n-e-4h` - P+N+E 4H\n* `iec-60309-p-n-e-6h` - P+N+E 6H\n* `iec-60309-p-n-e-9h` - P+N+E 9H\n* `iec-60309-2p-e-4h` - 2P+E 4H\n* `iec-60309-2p-e-6h` - 2P+E 6H\n* `iec-60309-2p-e-9h` - 2P+E 9H\n* `iec-60309-3p-e-4h` - 3P+E 4H\n* `iec-60309-3p-e-6h` - 3P+E 6H\n* `iec-60309-3p-e-9h` - 3P+E 9H\n* `iec-60309-3p-n-e-4h` - 3P+N+E 4H\n* `iec-60309-3p-n-e-6h` - 3P+N+E 6H\n* `iec-60309-3p-n-e-9h` - 3P+N+E 9H\n* `iec-60906-1` - IEC 60906-1\n* `nbr-14136-10a` - 2P+T 10A (NBR 14136)\n* `nbr-14136-20a` - 2P+T 20A (NBR 14136)\n* `nema-1-15p` - NEMA 1-15P\n* `nema-5-15p` - NEMA 5-15P\n* `nema-5-20p` - NEMA 5-20P\n* `nema-5-30p` - NEMA 5-30P\n* `nema-5-50p` - NEMA 5-50P\n* `nema-6-15p` - NEMA 6-15P\n* `nema-6-20p` - NEMA 6-20P\n* `nema-6-30p` - NEMA 6-30P\n* `nema-6-50p` - NEMA 6-50P\n* `nema-10-30p` - NEMA 10-30P\n* `nema-10-50p` - NEMA 10-50P\n* `nema-14-20p` - NEMA 14-20P\n* `nema-14-30p` - NEMA 14-30P\n* `nema-14-50p` - NEMA 14-50P\n* `nema-14-60p` - NEMA 14-60P\n* `nema-15-15p` - NEMA 15-15P\n* `nema-15-20p` - NEMA 15-20P\n* `nema-15-30p` - NEMA 15-30P\n* `nema-15-50p` - NEMA 15-50P\n* `nema-15-60p` - NEMA 15-60P\n* `nema-l1-15p` - NEMA L1-15P\n* `nema-l5-15p` - NEMA L5-15P\n* `nema-l5-20p` - NEMA L5-20P\n* `nema-l5-30p` - NEMA L5-30P\n* `nema-l5-50p` - NEMA L5-50P\n* `nema-l6-15p` - NEMA L6-15P\n* `nema-l6-20p` - NEMA L6-20P\n* `nema-l6-30p` - NEMA L6-30P\n* `nema-l6-50p` - NEMA L6-50P\n* `nema-l10-30p` - NEMA L10-30P\n* `nema-l14-20p` - NEMA L14-20P\n* `nema-l14-30p` - NEMA L14-30P\n* `nema-l14-50p` - NEMA L14-50P\n* `nema-l14-60p` - NEMA L14-60P\n* `nema-l15-20p` - NEMA L15-20P\n* `nema-l15-30p` - NEMA L15-30P\n* `nema-l15-50p` - NEMA L15-50P\n* `nema-l15-60p` - NEMA L15-60P\n* `nema-l21-20p` - NEMA L21-20P\n* `nema-l21-30p` - NEMA L21-30P\n* `nema-l22-20p` - NEMA L22-20P\n* `nema-l22-30p` - NEMA L22-30P\n* `cs6361c` - CS6361C\n* `cs6365c` - CS6365C\n* `cs8165c` - CS8165C\n* `cs8265c` - CS8265C\n* `cs8365c` - CS8365C\n* `cs8465c` - CS8465C\n* `ita-c` - ITA Type C (CEE 7/16)\n* `ita-e` - ITA Type E (CEE 7/6)\n* `ita-f` - ITA Type F (CEE 7/4)\n* `ita-ef` - ITA Type E/F (CEE 7/7)\n* `ita-g` - ITA Type G (BS 1363)\n* `ita-h` - ITA Type H\n* `ita-i` - ITA Type I\n* `ita-j` - ITA Type J\n* `ita-k` - ITA Type K\n* `ita-l` - ITA Type L (CEI 23-50)\n* `ita-m` - ITA Type M (BS 546)\n* `ita-n` - ITA Type N\n* `ita-o` - ITA Type O\n* `usb-a` - USB Type A\n* `usb-b` - USB Type B\n* `usb-c` - USB Type C\n* `usb-mini-a` - USB Mini A\n* `usb-mini-b` - USB Mini B\n* `usb-micro-a` - USB Micro A\n* `usb-micro-b` - USB Micro B\n* `usb-micro-ab` - USB Micro AB\n* `usb-3-b` - USB 3.0 Type B\n* `usb-3-micro-b` - USB 3.0 Micro B\n* `molex-micro-fit-1x2` - Molex Micro-Fit 1x2\n* `molex-micro-fit-2x2` - Molex Micro-Fit 2x2\n* `molex-micro-fit-2x4` - Molex Micro-Fit 2x4\n* `dc-terminal` - DC Terminal\n* `saf-d-grid` - Saf-D-Grid\n* `neutrik-powercon-20` - Neutrik powerCON (20A)\n* `neutrik-powercon-32` - Neutrik powerCON (32A)\n* `neutrik-powercon-true1` - Neutrik powerCON TRUE1\n* `neutrik-powercon-true1-top` - Neutrik powerCON TRUE1 TOP\n* `ubiquiti-smartpower` - Ubiquiti SmartPower\n* `hardwired` - Hardwired\n* `other` - Other",
"x-spec-enum-id": "292850be2c08f7df",
"nullable": true
},
"maximum_draw": {
"type": "integer",
"maximum": 2147483647,
"minimum": 1,
"nullable": true,
"description": "Maximum power draw (watts)"
},
"allocated_draw": {
"type": "integer",
"maximum": 2147483647,
"minimum": 1,
"nullable": true,
"description": "Allocated power draw (watts)"
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name"
]
},
"WritablePrefixRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"prefix": {
"type": "string",
"minLength": 1
},
"vrf": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefVRFRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"scope_type": {
"type": "string",
"nullable": true
},
"scope_id": {
"type": "integer",
"nullable": true
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"vlan": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefVLANRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"status": {
"enum": [
"container",
"active",
"reserved",
"deprecated"
],
"type": "string",
"x-spec-enum-id": "d38bee5f512701d9",
"description": "Operational status of this prefix\n\n* `container` - Container\n* `active` - Active\n* `reserved` - Reserved\n* `deprecated` - Deprecated"
},
"role": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefRoleRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"is_pool": {
"type": "boolean",
"title": "Is a pool",
"description": "All IP addresses within this prefix are considered usable"
},
"mark_utilized": {
"type": "boolean",
"description": "Treat as fully utilized"
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"prefix"
]
},
"WritableRackRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"facility_id": {
"type": "string",
"nullable": true,
"maxLength": 50
},
"site": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefSiteRequest"
}
]
},
"location": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefLocationRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"status": {
"enum": [
"reserved",
"available",
"planned",
"active",
"deprecated"
],
"type": "string",
"description": "* `reserved` - Reserved\n* `available` - Available\n* `planned` - Planned\n* `active` - Active\n* `deprecated` - Deprecated",
"x-spec-enum-id": "0c556d55dc1baa13"
},
"role": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefRackRoleRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"serial": {
"type": "string",
"title": "Serial number",
"maxLength": 50
},
"asset_tag": {
"type": "string",
"nullable": true,
"description": "A unique tag used to identify this rack",
"maxLength": 50
},
"rack_type": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefRackTypeRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"form_factor": {
"enum": [
"2-post-frame",
"4-post-frame",
"4-post-cabinet",
"wall-frame",
"wall-frame-vertical",
"wall-cabinet",
"wall-cabinet-vertical",
"",
null
],
"type": "string",
"description": "* `2-post-frame` - 2-post frame\n* `4-post-frame` - 4-post frame\n* `4-post-cabinet` - 4-post cabinet\n* `wall-frame` - Wall-mounted frame\n* `wall-frame-vertical` - Wall-mounted frame (vertical)\n* `wall-cabinet` - Wall-mounted cabinet\n* `wall-cabinet-vertical` - Wall-mounted cabinet (vertical)",
"x-spec-enum-id": "e32aaa89a223f2ea",
"nullable": true
},
"width": {
"enum": [
10,
19,
21,
23
],
"type": "integer",
"x-spec-enum-id": "9b322795f297a9c3",
"description": "Rail-to-rail width\n\n* `10` - 10 inches\n* `19` - 19 inches\n* `21` - 21 inches\n* `23` - 23 inches",
"minimum": 0,
"maximum": 32767
},
"u_height": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"title": "Height (U)",
"description": "Height in rack units"
},
"starting_unit": {
"type": "integer",
"maximum": 32767,
"minimum": 1,
"description": "Starting unit for rack"
},
"weight": {
"type": "number",
"format": "double",
"maximum": 1000000,
"minimum": -1000000,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true
},
"max_weight": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"description": "Maximum load capacity for the rack"
},
"weight_unit": {
"enum": [
"kg",
"g",
"lb",
"oz",
"",
null
],
"type": "string",
"description": "* `kg` - Kilograms\n* `g` - Grams\n* `lb` - Pounds\n* `oz` - Ounces",
"x-spec-enum-id": "7c1876f422815884",
"nullable": true
},
"desc_units": {
"type": "boolean",
"title": "Descending units",
"description": "Units are numbered top-to-bottom"
},
"outer_width": {
"type": "integer",
"maximum": 32767,
"minimum": 0,
"nullable": true,
"description": "Outer dimension of rack (width)"
},
"outer_height": {
"type": "integer",
"maximum": 32767,
"minimum": 0,
"nullable": true,
"description": "Outer dimension of rack (height)"
},
"outer_depth": {
"type": "integer",
"maximum": 32767,
"minimum": 0,
"nullable": true,
"description": "Outer dimension of rack (depth)"
},
"outer_unit": {
"enum": [
"mm",
"in",
"",
null
],
"type": "string",
"description": "* `mm` - Millimeters\n* `in` - Inches",
"x-spec-enum-id": "86a846b6c40f495e",
"nullable": true
},
"mounting_depth": {
"type": "integer",
"maximum": 32767,
"minimum": 0,
"nullable": true,
"description": "Maximum depth of a mounted device, in millimeters. For four-post racks, this is the distance between the front and rear rails."
},
"airflow": {
"enum": [
"front-to-rear",
"rear-to-front",
"",
null
],
"type": "string",
"description": "* `front-to-rear` - Front to rear\n* `rear-to-front` - Rear to front",
"x-spec-enum-id": "a784734d07ef1b3c",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name",
"site"
]
},
"WritableRackReservationRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"rack": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefRackRequest"
}
]
},
"units": {
"type": "array",
"items": {
"type": "integer",
"maximum": 32767,
"minimum": 0
}
},
"status": {
"enum": [
"pending",
"active",
"stale"
],
"type": "string",
"description": "* `pending` - Pending\n* `active` - Active\n* `stale` - Stale",
"x-spec-enum-id": "b62013475549e423"
},
"user": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefUserRequest"
}
]
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"description": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"description",
"rack",
"units",
"user"
]
},
"WritableRackTypeRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"manufacturer": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefManufacturerRequest"
}
]
},
"model": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"description": {
"type": "string",
"maxLength": 200
},
"form_factor": {
"enum": [
"2-post-frame",
"4-post-frame",
"4-post-cabinet",
"wall-frame",
"wall-frame-vertical",
"wall-cabinet",
"wall-cabinet-vertical"
],
"type": "string",
"description": "* `2-post-frame` - 2-post frame\n* `4-post-frame` - 4-post frame\n* `4-post-cabinet` - 4-post cabinet\n* `wall-frame` - Wall-mounted frame\n* `wall-frame-vertical` - Wall-mounted frame (vertical)\n* `wall-cabinet` - Wall-mounted cabinet\n* `wall-cabinet-vertical` - Wall-mounted cabinet (vertical)",
"x-spec-enum-id": "e32aaa89a223f2ea"
},
"width": {
"enum": [
10,
19,
21,
23
],
"type": "integer",
"x-spec-enum-id": "9b322795f297a9c3",
"description": "Rail-to-rail width\n\n* `10` - 10 inches\n* `19` - 19 inches\n* `21` - 21 inches\n* `23` - 23 inches",
"minimum": 0,
"maximum": 32767
},
"u_height": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"title": "Height (U)",
"description": "Height in rack units"
},
"starting_unit": {
"type": "integer",
"maximum": 32767,
"minimum": 1,
"description": "Starting unit for rack"
},
"desc_units": {
"type": "boolean",
"title": "Descending units",
"description": "Units are numbered top-to-bottom"
},
"outer_width": {
"type": "integer",
"maximum": 32767,
"minimum": 0,
"nullable": true,
"description": "Outer dimension of rack (width)"
},
"outer_height": {
"type": "integer",
"maximum": 32767,
"minimum": 0,
"nullable": true,
"description": "Outer dimension of rack (height)"
},
"outer_depth": {
"type": "integer",
"maximum": 32767,
"minimum": 0,
"nullable": true,
"description": "Outer dimension of rack (depth)"
},
"outer_unit": {
"enum": [
"mm",
"in",
"",
null
],
"type": "string",
"description": "* `mm` - Millimeters\n* `in` - Inches",
"x-spec-enum-id": "86a846b6c40f495e",
"nullable": true
},
"weight": {
"type": "number",
"format": "double",
"maximum": 1000000,
"minimum": -1000000,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true
},
"max_weight": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"description": "Maximum load capacity for the rack"
},
"weight_unit": {
"enum": [
"kg",
"g",
"lb",
"oz",
"",
null
],
"type": "string",
"description": "* `kg` - Kilograms\n* `g` - Grams\n* `lb` - Pounds\n* `oz` - Ounces",
"x-spec-enum-id": "7c1876f422815884",
"nullable": true
},
"mounting_depth": {
"type": "integer",
"maximum": 32767,
"minimum": 0,
"nullable": true,
"description": "Maximum depth of a mounted device, in millimeters. For four-post racks, this is the distance between the front and rear rails."
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"form_factor",
"manufacturer",
"model",
"slug"
]
},
"WritableRearPortRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"device": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDeviceRequest"
}
]
},
"module": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"enum": [
"8p8c",
"8p6c",
"8p4c",
"8p2c",
"6p6c",
"6p4c",
"6p2c",
"4p4c",
"4p2c",
"gg45",
"tera-4p",
"tera-2p",
"tera-1p",
"110-punch",
"bnc",
"f",
"n",
"mrj21",
"fc",
"fc-pc",
"fc-upc",
"fc-apc",
"lc",
"lc-pc",
"lc-upc",
"lc-apc",
"lsh",
"lsh-pc",
"lsh-upc",
"lsh-apc",
"lx5",
"lx5-pc",
"lx5-upc",
"lx5-apc",
"mpo",
"mtrj",
"sc",
"sc-pc",
"sc-upc",
"sc-apc",
"st",
"cs",
"sn",
"sma-905",
"sma-906",
"urm-p2",
"urm-p4",
"urm-p8",
"splice",
"usb-a",
"usb-b",
"usb-c",
"usb-mini-a",
"usb-mini-b",
"usb-micro-a",
"usb-micro-b",
"usb-micro-ab",
"other"
],
"type": "string",
"description": "* `8p8c` - 8P8C\n* `8p6c` - 8P6C\n* `8p4c` - 8P4C\n* `8p2c` - 8P2C\n* `6p6c` - 6P6C\n* `6p4c` - 6P4C\n* `6p2c` - 6P2C\n* `4p4c` - 4P4C\n* `4p2c` - 4P2C\n* `gg45` - GG45\n* `tera-4p` - TERA 4P\n* `tera-2p` - TERA 2P\n* `tera-1p` - TERA 1P\n* `110-punch` - 110 Punch\n* `bnc` - BNC\n* `f` - F Connector\n* `n` - N Connector\n* `mrj21` - MRJ21\n* `fc` - FC\n* `fc-pc` - FC/PC\n* `fc-upc` - FC/UPC\n* `fc-apc` - FC/APC\n* `lc` - LC\n* `lc-pc` - LC/PC\n* `lc-upc` - LC/UPC\n* `lc-apc` - LC/APC\n* `lsh` - LSH\n* `lsh-pc` - LSH/PC\n* `lsh-upc` - LSH/UPC\n* `lsh-apc` - LSH/APC\n* `lx5` - LX.5\n* `lx5-pc` - LX.5/PC\n* `lx5-upc` - LX.5/UPC\n* `lx5-apc` - LX.5/APC\n* `mpo` - MPO\n* `mtrj` - MTRJ\n* `sc` - SC\n* `sc-pc` - SC/PC\n* `sc-upc` - SC/UPC\n* `sc-apc` - SC/APC\n* `st` - ST\n* `cs` - CS\n* `sn` - SN\n* `sma-905` - SMA 905\n* `sma-906` - SMA 906\n* `urm-p2` - URM-P2\n* `urm-p4` - URM-P4\n* `urm-p8` - URM-P8\n* `splice` - Splice\n* `usb-a` - USB Type A\n* `usb-b` - USB Type B\n* `usb-c` - USB Type C\n* `usb-mini-a` - USB Mini A\n* `usb-mini-b` - USB Mini B\n* `usb-micro-a` - USB Micro A\n* `usb-micro-b` - USB Micro B\n* `usb-micro-ab` - USB Micro AB\n* `other` - Other",
"x-spec-enum-id": "ea67ae8ba4602f8a"
},
"color": {
"type": "string",
"pattern": "^[0-9a-f]{6}$",
"maxLength": 6
},
"positions": {
"type": "integer",
"maximum": 1024,
"minimum": 1,
"description": "Number of front ports which may be mapped"
},
"description": {
"type": "string",
"maxLength": 200
},
"mark_connected": {
"type": "boolean",
"description": "Treat as if a cable is connected"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"device",
"name",
"type"
]
},
"WritableRearPortTemplateRequest": {
"type": "object",
"description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)",
"properties": {
"device_type": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefDeviceTypeRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"module_type": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefModuleTypeRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"name": {
"type": "string",
"minLength": 1,
"description": "{module} is accepted as a substitution for the module bay position when attached to a module type.",
"maxLength": 64
},
"label": {
"type": "string",
"description": "Physical label",
"maxLength": 64
},
"type": {
"enum": [
"8p8c",
"8p6c",
"8p4c",
"8p2c",
"6p6c",
"6p4c",
"6p2c",
"4p4c",
"4p2c",
"gg45",
"tera-4p",
"tera-2p",
"tera-1p",
"110-punch",
"bnc",
"f",
"n",
"mrj21",
"fc",
"fc-pc",
"fc-upc",
"fc-apc",
"lc",
"lc-pc",
"lc-upc",
"lc-apc",
"lsh",
"lsh-pc",
"lsh-upc",
"lsh-apc",
"lx5",
"lx5-pc",
"lx5-upc",
"lx5-apc",
"mpo",
"mtrj",
"sc",
"sc-pc",
"sc-upc",
"sc-apc",
"st",
"cs",
"sn",
"sma-905",
"sma-906",
"urm-p2",
"urm-p4",
"urm-p8",
"splice",
"usb-a",
"usb-b",
"usb-c",
"usb-mini-a",
"usb-mini-b",
"usb-micro-a",
"usb-micro-b",
"usb-micro-ab",
"other"
],
"type": "string",
"description": "* `8p8c` - 8P8C\n* `8p6c` - 8P6C\n* `8p4c` - 8P4C\n* `8p2c` - 8P2C\n* `6p6c` - 6P6C\n* `6p4c` - 6P4C\n* `6p2c` - 6P2C\n* `4p4c` - 4P4C\n* `4p2c` - 4P2C\n* `gg45` - GG45\n* `tera-4p` - TERA 4P\n* `tera-2p` - TERA 2P\n* `tera-1p` - TERA 1P\n* `110-punch` - 110 Punch\n* `bnc` - BNC\n* `f` - F Connector\n* `n` - N Connector\n* `mrj21` - MRJ21\n* `fc` - FC\n* `fc-pc` - FC/PC\n* `fc-upc` - FC/UPC\n* `fc-apc` - FC/APC\n* `lc` - LC\n* `lc-pc` - LC/PC\n* `lc-upc` - LC/UPC\n* `lc-apc` - LC/APC\n* `lsh` - LSH\n* `lsh-pc` - LSH/PC\n* `lsh-upc` - LSH/UPC\n* `lsh-apc` - LSH/APC\n* `lx5` - LX.5\n* `lx5-pc` - LX.5/PC\n* `lx5-upc` - LX.5/UPC\n* `lx5-apc` - LX.5/APC\n* `mpo` - MPO\n* `mtrj` - MTRJ\n* `sc` - SC\n* `sc-pc` - SC/PC\n* `sc-upc` - SC/UPC\n* `sc-apc` - SC/APC\n* `st` - ST\n* `cs` - CS\n* `sn` - SN\n* `sma-905` - SMA 905\n* `sma-906` - SMA 906\n* `urm-p2` - URM-P2\n* `urm-p4` - URM-P4\n* `urm-p8` - URM-P8\n* `splice` - Splice\n* `usb-a` - USB Type A\n* `usb-b` - USB Type B\n* `usb-c` - USB Type C\n* `usb-mini-a` - USB Mini A\n* `usb-mini-b` - USB Mini B\n* `usb-micro-a` - USB Micro A\n* `usb-micro-b` - USB Micro B\n* `usb-micro-ab` - USB Micro AB\n* `other` - Other",
"x-spec-enum-id": "ea67ae8ba4602f8a"
},
"color": {
"type": "string",
"pattern": "^[0-9a-f]{6}$",
"maxLength": 6
},
"positions": {
"type": "integer",
"maximum": 1024,
"minimum": 1
},
"description": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name",
"type"
]
},
"WritableRegionRequest": {
"type": "object",
"description": "Extends PrimaryModelSerializer to include MPTT support.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"parent": {
"type": "integer",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"comments": {
"type": "string"
}
},
"required": [
"name",
"slug"
]
},
"WritableServiceRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"parent_object_type": {
"type": "string"
},
"parent_object_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"protocol": {
"enum": [
"tcp",
"udp",
"sctp"
],
"type": "string",
"description": "* `tcp` - TCP\n* `udp` - UDP\n* `sctp` - SCTP",
"x-spec-enum-id": "5521e084b1ad51de"
},
"ports": {
"type": "array",
"items": {
"type": "integer",
"maximum": 65535,
"minimum": 1
},
"title": "Port numbers"
},
"ipaddresses": {
"type": "array",
"items": {
"type": "integer"
}
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name",
"parent_object_id",
"parent_object_type",
"ports",
"protocol"
]
},
"WritableServiceTemplateRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"protocol": {
"enum": [
"tcp",
"udp",
"sctp"
],
"type": "string",
"description": "* `tcp` - TCP\n* `udp` - UDP\n* `sctp` - SCTP",
"x-spec-enum-id": "5521e084b1ad51de"
},
"ports": {
"type": "array",
"items": {
"type": "integer",
"maximum": 65535,
"minimum": 1
},
"title": "Port numbers"
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name",
"ports",
"protocol"
]
},
"WritableSiteGroupRequest": {
"type": "object",
"description": "Extends PrimaryModelSerializer to include MPTT support.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"parent": {
"type": "integer",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"comments": {
"type": "string"
}
},
"required": [
"name",
"slug"
]
},
"WritableSiteRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"description": "Full name of the site",
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"status": {
"enum": [
"planned",
"staging",
"active",
"decommissioning",
"retired"
],
"type": "string",
"description": "* `planned` - Planned\n* `staging` - Staging\n* `active` - Active\n* `decommissioning` - Decommissioning\n* `retired` - Retired",
"x-spec-enum-id": "e363a8ddb138be50"
},
"region": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefRegionRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"group": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefSiteGroupRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"facility": {
"type": "string",
"description": "Local facility ID or description",
"maxLength": 50
},
"time_zone": {
"type": "string",
"nullable": true,
"minLength": 1
},
"description": {
"type": "string",
"maxLength": 200
},
"physical_address": {
"type": "string",
"description": "Physical location of the building",
"maxLength": 200
},
"shipping_address": {
"type": "string",
"description": "If different from the physical address",
"maxLength": 200
},
"latitude": {
"type": "number",
"format": "double",
"maximum": 100,
"minimum": -100,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true,
"description": "GPS coordinate in decimal format (xx.yyyyyy)"
},
"longitude": {
"type": "number",
"format": "double",
"maximum": 1000,
"minimum": -1000,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true,
"description": "GPS coordinate in decimal format (xx.yyyyyy)"
},
"comments": {
"type": "string"
},
"asns": {
"type": "array",
"items": {
"type": "integer"
}
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name",
"slug"
]
},
"WritableTenantGroupRequest": {
"type": "object",
"description": "Extends PrimaryModelSerializer to include MPTT support.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"parent": {
"type": "integer",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"comments": {
"type": "string"
}
},
"required": [
"name",
"slug"
]
},
"WritableTunnelRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"status": {
"enum": [
"planned",
"active",
"disabled"
],
"type": "string",
"description": "* `planned` - Planned\n* `active` - Active\n* `disabled` - Disabled",
"x-spec-enum-id": "0d65f7912cba74aa"
},
"group": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTunnelGroupRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"encapsulation": {
"enum": [
"ipsec-transport",
"ipsec-tunnel",
"ip-ip",
"gre",
"wireguard",
"openvpn",
"l2tp",
"pptp"
],
"type": "string",
"description": "* `ipsec-transport` - IPsec - Transport\n* `ipsec-tunnel` - IPsec - Tunnel\n* `ip-ip` - IP-in-IP\n* `gre` - GRE\n* `wireguard` - WireGuard\n* `openvpn` - OpenVPN\n* `l2tp` - L2TP\n* `pptp` - PPTP",
"x-spec-enum-id": "54a2e45824009c49"
},
"ipsec_profile": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefIPSecProfileRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"tunnel_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"encapsulation",
"name"
]
},
"WritableTunnelTerminationRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"tunnel": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefTunnelRequest"
}
]
},
"role": {
"enum": [
"peer",
"hub",
"spoke"
],
"type": "string",
"description": "* `peer` - Peer\n* `hub` - Hub\n* `spoke` - Spoke",
"x-spec-enum-id": "52225cd60b867572"
},
"termination_type": {
"type": "string"
},
"termination_id": {
"type": "integer",
"maximum": 9223372036854775807,
"minimum": 0,
"format": "int64",
"nullable": true
},
"outside_ip": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefIPAddressRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"termination_type",
"tunnel"
]
},
"WritableVLANRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"site": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefSiteRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"group": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefVLANGroupRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"vid": {
"type": "integer",
"maximum": 4094,
"minimum": 1,
"title": "VLAN ID",
"description": "Numeric VLAN ID (1-4094)"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"status": {
"enum": [
"active",
"reserved",
"deprecated"
],
"type": "string",
"x-spec-enum-id": "6388dfb94ca1cc15",
"description": "Operational status of this VLAN\n\n* `active` - Active\n* `reserved` - Reserved\n* `deprecated` - Deprecated"
},
"role": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefRoleRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"qinq_role": {
"enum": [
"svlan",
"cvlan",
"",
null
],
"type": "string",
"x-spec-enum-id": "d2510f2d3e3d3fb1",
"nullable": true,
"title": "Q-in-Q role",
"description": "Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad)\n\n* `svlan` - Service\n* `cvlan` - Customer"
},
"qinq_svlan": {
"type": "integer",
"nullable": true
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name",
"vid"
]
},
"WritableVMInterfaceRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"virtual_machine": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefVirtualMachineRequest"
}
]
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"enabled": {
"type": "boolean"
},
"parent": {
"type": "integer",
"nullable": true,
"title": "Parent interface"
},
"bridge": {
"type": "integer",
"nullable": true,
"title": "Bridge interface"
},
"mtu": {
"type": "integer",
"maximum": 65536,
"minimum": 1,
"nullable": true
},
"primary_mac_address": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefMACAddressRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"mode": {
"enum": [
"access",
"tagged",
"tagged-all",
"q-in-q",
"",
null
],
"type": "string",
"x-spec-enum-id": "b6fe48fe21dbf01d",
"nullable": true,
"description": "IEEE 802.1Q tagging strategy\n\n* `access` - Access\n* `tagged` - Tagged\n* `tagged-all` - Tagged (All)\n* `q-in-q` - Q-in-Q (802.1ad)"
},
"untagged_vlan": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefVLANRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"tagged_vlans": {
"type": "array",
"items": {
"type": "integer"
}
},
"qinq_svlan": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefVLANRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"vlan_translation_policy": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefVLANTranslationPolicyRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"vrf": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefVRFRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name",
"virtual_machine"
]
},
"WritableVirtualChassisRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"domain": {
"type": "string",
"maxLength": 30
},
"master": {
"type": "integer",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name"
]
},
"WritableVirtualCircuitRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"cid": {
"type": "string",
"minLength": 1,
"title": "Circuit ID",
"description": "Unique circuit ID",
"maxLength": 100
},
"provider_network": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefProviderNetworkRequest"
}
]
},
"provider_account": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefProviderAccountRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"type": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefVirtualCircuitTypeRequest"
}
]
},
"status": {
"enum": [
"planned",
"provisioning",
"active",
"offline",
"deprovisioning",
"decommissioned"
],
"type": "string",
"description": "* `planned` - Planned\n* `provisioning` - Provisioning\n* `active` - Active\n* `offline` - Offline\n* `deprovisioning` - Deprovisioning\n* `decommissioned` - Decommissioned",
"x-spec-enum-id": "63c838134a022200"
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"cid",
"provider_network",
"type"
]
},
"WritableVirtualCircuitTerminationRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"virtual_circuit": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefVirtualCircuitRequest"
}
]
},
"role": {
"enum": [
"peer",
"hub",
"spoke"
],
"type": "string",
"description": "* `peer` - Peer\n* `hub` - Hub\n* `spoke` - Spoke",
"x-spec-enum-id": "52225cd60b867572"
},
"interface": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefInterfaceRequest"
}
]
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"interface",
"virtual_circuit"
]
},
"WritableVirtualDeviceContextRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"device": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefDeviceRequest"
}
]
},
"identifier": {
"type": "integer",
"maximum": 32767,
"minimum": 0,
"nullable": true
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"primary_ip4": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefIPAddressRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"primary_ip6": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefIPAddressRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"status": {
"enum": [
"active",
"planned",
"offline"
],
"type": "string",
"description": "* `active` - Active\n* `planned` - Planned\n* `offline` - Offline",
"x-spec-enum-id": "ee1ef02def7a91ab"
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"device",
"name",
"status"
]
},
"WritableVirtualMachineWithConfigContextRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"status": {
"enum": [
"offline",
"active",
"planned",
"staged",
"failed",
"decommissioning",
"paused"
],
"type": "string",
"description": "* `offline` - Offline\n* `active` - Active\n* `planned` - Planned\n* `staged` - Staged\n* `failed` - Failed\n* `decommissioning` - Decommissioning\n* `paused` - Paused",
"x-spec-enum-id": "c649dc8de233760f"
},
"site": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefSiteRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"cluster": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefClusterRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"device": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefDeviceRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"serial": {
"type": "string",
"title": "Serial number",
"maxLength": 50
},
"role": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefDeviceRoleRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"platform": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefPlatformRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"primary_ip4": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefIPAddressRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"primary_ip6": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefIPAddressRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"vcpus": {
"type": "number",
"format": "double",
"maximum": 10000,
"minimum": 0.01,
"exclusiveMaximum": true,
"nullable": true
},
"memory": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"title": "Memory (MB)"
},
"disk": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"nullable": true,
"title": "Disk (MB)"
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"config_template": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefConfigTemplateRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"local_context_data": {
"nullable": true,
"description": "Local config context data takes precedence over source contexts in the final rendered config context"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"name"
]
},
"WritableWirelessLANGroupRequest": {
"type": "object",
"description": "Extends PrimaryModelSerializer to include MPTT support.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"parent": {
"type": "integer",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
},
"comments": {
"type": "string"
}
},
"required": [
"name",
"slug"
]
},
"WritableWirelessLANRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"ssid": {
"type": "string",
"minLength": 1,
"maxLength": 32
},
"description": {
"type": "string",
"maxLength": 200
},
"group": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefWirelessLANGroupRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"status": {
"enum": [
"active",
"reserved",
"disabled",
"deprecated"
],
"type": "string",
"description": "* `active` - Active\n* `reserved` - Reserved\n* `disabled` - Disabled\n* `deprecated` - Deprecated",
"x-spec-enum-id": "412ebdca597f609e"
},
"vlan": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefVLANRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"scope_type": {
"type": "string",
"nullable": true
},
"scope_id": {
"type": "integer",
"nullable": true
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"auth_type": {
"enum": [
"open",
"wep",
"wpa-personal",
"wpa-enterprise",
"",
null
],
"type": "string",
"description": "* `open` - Open\n* `wep` - WEP\n* `wpa-personal` - WPA Personal (PSK)\n* `wpa-enterprise` - WPA Enterprise",
"x-spec-enum-id": "a2043acb899b3954",
"nullable": true,
"title": "Authentication type"
},
"auth_cipher": {
"enum": [
"auto",
"tkip",
"aes",
"",
null
],
"type": "string",
"description": "* `auto` - Auto\n* `tkip` - TKIP\n* `aes` - AES",
"x-spec-enum-id": "8fdaefa727c26fdc",
"nullable": true,
"title": "Authentication cipher"
},
"auth_psk": {
"type": "string",
"title": "Pre-shared key",
"maxLength": 64
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"ssid"
]
},
"WritableWirelessLinkRequest": {
"type": "object",
"description": "Adds support for custom fields and tags.",
"properties": {
"interface_a": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefInterfaceRequest"
}
]
},
"interface_b": {
"oneOf": [
{
"type": "integer"
},
{
"$ref": "#/components/schemas/BriefInterfaceRequest"
}
]
},
"ssid": {
"type": "string",
"maxLength": 32
},
"status": {
"enum": [
"connected",
"planned",
"decommissioning"
],
"type": "string",
"description": "* `connected` - Connected\n* `planned` - Planned\n* `decommissioning` - Decommissioning",
"x-spec-enum-id": "fbc2f302c08be50d"
},
"tenant": {
"oneOf": [
{
"type": "integer"
},
{
"allOf": [
{
"$ref": "#/components/schemas/BriefTenantRequest"
}
],
"nullable": true
}
],
"nullable": true
},
"auth_type": {
"enum": [
"open",
"wep",
"wpa-personal",
"wpa-enterprise",
"",
null
],
"type": "string",
"description": "* `open` - Open\n* `wep` - WEP\n* `wpa-personal` - WPA Personal (PSK)\n* `wpa-enterprise` - WPA Enterprise",
"x-spec-enum-id": "a2043acb899b3954",
"nullable": true,
"title": "Authentication type"
},
"auth_cipher": {
"enum": [
"auto",
"tkip",
"aes",
"",
null
],
"type": "string",
"description": "* `auto` - Auto\n* `tkip` - TKIP\n* `aes` - AES",
"x-spec-enum-id": "8fdaefa727c26fdc",
"nullable": true,
"title": "Authentication cipher"
},
"auth_psk": {
"type": "string",
"title": "Pre-shared key",
"maxLength": 64
},
"distance": {
"type": "number",
"format": "double",
"maximum": 1000000,
"minimum": -1000000,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"nullable": true
},
"distance_unit": {
"enum": [
"km",
"m",
"mi",
"ft",
"",
null
],
"type": "string",
"description": "* `km` - Kilometers\n* `m` - Meters\n* `mi` - Miles\n* `ft` - Feet",
"x-spec-enum-id": "53542e7902f946af",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 200
},
"comments": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedTagRequest"
}
},
"custom_fields": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"interface_a",
"interface_b"
]
}
},
"securitySchemes": {
"cookieAuth": {
"type": "apiKey",
"in": "cookie",
"name": "sessionid"
},
"tokenAuth": {
"type": "apiKey",
"in": "header",
"name": "Authorization",
"description": "Token-based authentication with required prefix \"Token\""
}
}
},
"servers": [
{
"url": "",
"description": "NetBox"
}
]
}